~ubuntu-branches/ubuntu/trusty/enigma/trusty-proposed : revision 14

1

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd">

2

<html>

3

<!-- Created on April 1, 2013 by texi2html 1.82

4

texi2html was written by:

5

Lionel Cons <Lionel.Cons@cern.ch> (original author)

6

Karl Berry <karl@freefriends.org>

7

Olaf Bachmann <obachman@mathematik.uni-kl.de>

8

and many others.

9

Maintained by: Many creative people.

10

Send bugs and suggestions to <texi2html-bug@nongnu.org>

11

-->

12

<head>

13

<title>Enigma Reference Manual</title>

14

15

16

17

18

19

20

21

22

<!--

23

a.summary-letter {text-decoration: none}

24

blockquote.smallquotation {font-size: smaller}

25

code {color:rgb(0%,50%,0%)}

26

h3 {background-color:rgb(95%,95%,100%)}

27

hr {height:0px;}

28

pre.display {font-family: serif}

29

pre.example {background-color:rgb(97%,97%,97%)}

30

pre.example b {color:rgb(0%,0%,100%); font-weight:normal}

31

pre.example i {color:rgb(0%,60%,0%); font-style:normal}

32

pre.example var {color:rgb(80%,0%,80%)}

33

pre.format {font-family: serif}

34

pre.menu-comment {font-family: serif}

35

pre.menu-preformatted {font-family: serif}

36

pre.smalldisplay {font-family: serif; font-size: smaller}

37

pre.smallexample {font-size: smaller}

38

pre.smallformat {font-family: serif; font-size: smaller}

39

pre.smalllisp {font-size: smaller}

40

samp {color:rgb(0%,50%,0%)}

41

span.roman {font-family:serif; font-weight:normal;}

42

span.sansserif {font-family:sans-serif; font-weight:normal;}

43

ul.toc {list-style: none}

44

-->

45

</style>

46

47

48

</head>

49

50

51

52

53

54

55

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

56

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

57

58

</tr></table>

59

60

<h1 class="settitle">Enigma Reference Manual</h1>

61

62

This manual describes the internals of

63

<a href="http://www.nongnu.org/enigma/">Enigma</a> version 1.20, in particular how to

64

build new levels using Lua and how to interact with the game engine.

65

66

67

<tr><td align="left" valign="top"><a href="#Running-Enigma">1. Running Enigma</a></td><td>  </td><td align="left" valign="top"></td></tr>

68

<tr><td align="left" valign="top"><a href="#Levelpack-Basics">2. Levelpack Basics</a></td><td>  </td><td align="left" valign="top"> Addition and managing of levels in packs

69

</td></tr>

70

<tr><td align="left" valign="top"><a href="#Level-Basics">3. Level Basics</a></td><td>  </td><td align="left" valign="top"> Introduction to level description

71

</td></tr>

72

<tr><td align="left" valign="top"><a href="#Enigma-Paradigm">4. Enigma Paradigm</a></td><td>  </td><td align="left" valign="top"> Principles of world, objects and messages

73

</td></tr>

74

<tr><td align="left" valign="top"><a href="#Lua-API">5. Lua API</a></td><td>  </td><td align="left" valign="top"> Describing a level with all its objects and interactions

75

</td></tr>

76

<tr><td align="left" valign="top"><a href="#Common-Attributes-and-Messages">6. Common Attributes and Messages</a></td><td>  </td><td align="left" valign="top"> What all objects support

77

</td></tr>

78

<tr><td align="left" valign="top"><a href="#Floor-Objects">7. Floor Objects</a></td><td>  </td><td align="left" valign="top">

79

</td></tr>

80

<tr><td align="left" valign="top"><a href="#Item-Objects">8. Item Objects</a></td><td>  </td><td align="left" valign="top">

81

</td></tr>

82

<tr><td align="left" valign="top"><a href="#Stone-Objects">9. Stone Objects</a></td><td>  </td><td align="left" valign="top">

83

</td></tr>

84

<tr><td align="left" valign="top"><a href="#Actor-Objects">10. Actor Objects</a></td><td>  </td><td align="left" valign="top">

85

</td></tr>

86

<tr><td align="left" valign="top"><a href="#Other-Objects">11. Other Objects</a></td><td>  </td><td align="left" valign="top"> Wires, Rubberbands and Gadgets

87

</td></tr>

88

<tr><td align="left" valign="top"><a href="#Libraries">12. Libraries</a></td><td>  </td><td align="left" valign="top"> Supplemental Functions and Features

89

</td></tr>

90

<tr><td align="left" valign="top"><a href="#Advanced-Features">13. Advanced Features</a></td><td>  </td><td align="left" valign="top"> Resolvers, Scrolling, Flood, Fire, etc.

91

</td></tr>

92

<tr><td align="left" valign="top"><a href="#Extension-Development">14. Extension Development</a></td><td>  </td><td align="left" valign="top"> Resolver, Library Development

93

</td></tr>

94

<tr><td align="left" valign="top"><a href="#Guidelines-and-Hints">15. Guidelines and Hints</a></td><td>  </td><td align="left" valign="top"> Tips and Recommendations for Levels to be included in Enigma

95

</td></tr>

96

<tr><td align="left" valign="top"><a href="#Compatibility">16. Compatibility</a></td><td>  </td><td align="left" valign="top"> Engine Mode and Version Compatibility

97

</td></tr>

98

<tr><td align="left" valign="top"><a href="#Object-Index">Object Index</a></td><td>  </td><td align="left" valign="top">

99

</td></tr>

100

<tr><td align="left" valign="top"><a href="#Attribute-Index">Attribute Index</a></td><td>  </td><td align="left" valign="top">

101

</td></tr>

102

<tr><td align="left" valign="top"><a href="#Message-Index">Message Index</a></td><td>  </td><td align="left" valign="top">

103

</td></tr>

104

<tr><td align="left" valign="top"><a href="#Function-Index">Function Index</a></td><td>  </td><td align="left" valign="top">

105

</td></tr>

106

<tr><td align="left" valign="top"><a href="#Concept-Index">Concept Index</a></td><td>  </td><td align="left" valign="top">

107

</td></tr>

108

<tr><td align="left" valign="top"><a href="#Renaming-Index">Renaming Index</a></td><td>  </td><td align="left" valign="top"> Old API to new API translation hints

109

</td></tr>

110

</table>

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

127

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

128

129

</tr></table>

130

131

<h1 class="chapter">1. Running Enigma</h1>

132

133

Hopefully, after successfully installing and playing some first levels, you may be interested in

134

some information about how we have configured Enigma, how you can optimize Enigma to your

135

needs, and the purpose of some options and attributes within Enigma.

136

137

This first chapter should give you some valuable information about these questions, and provide

138

some basic knowledge you will need to manage level packs, levels or write your own levels, as

139

described in the following chapters.

140

141

142

<tr><td align="left" valign="top"><a href="#Locating-Resources">1.1 Locating Resources</a></td><td>  </td><td align="left" valign="top">

143

</td></tr>

144

<tr><td align="left" valign="top"><a href="#Startup-Switches">1.2 Startup Switches</a></td><td>  </td><td align="left" valign="top">

145

</td></tr>

146

<tr><td align="left" valign="top"><a href="#User-Options">1.3 User Options</a></td><td>  </td><td align="left" valign="top">

147

</td></tr>

148

<tr><td align="left" valign="top"><a href="#Inventory-Console">1.4 Inventory Console</a></td><td>  </td><td align="left" valign="top"> Command and document text history

149

</td></tr>

150

<tr><td align="left" valign="top"><a href="#Level-Info">1.5 Level Info</a></td><td>  </td><td align="left" valign="top">

151

</td></tr>

152

<tr><td align="left" valign="top"><a href="#Handicap-and-PAR">1.6 Handicap and PAR</a></td><td>  </td><td align="left" valign="top"> Background to score evaluation and HCP

153

</td></tr>

154

<tr><td align="left" valign="top"><a href="#User-Sound-Sets">1.7 User Sound Sets</a></td><td>  </td><td align="left" valign="top"> How to create and install sound themes

155

</td></tr>

156

</table>

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

173

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

174

175

</tr></table>

176

177

<h2 class="section">1.1 Locating Resources</h2>

178

179

For reasons of backup, system changes, special configurations, level additions and hopefully

180

your own new levels, you may need to know where Enigma stores the resources and how you

181

can control them.

182

183

Enigma maintains several paths for control of load and storage of files. You

184

can list these paths either in the help submenu paths, or by starting Enigma

185

with the switch ‘<samp>--log</samp>’ (see section <a href="#Startup-Switches">Startup Switches</a>) and looking at the

186

console output.

187

188

189

190

</dd>

191

<dt> Preferences Path</dt>

192

<dd>This is the path to the file that stores your preferences concerning application

193

options. This file is usually located at your <code>HOME</code> directory. For <code>HOME</code>-less

194

Windows users, it is stored in the ‘<samp>Application Data\Enigma</samp>’ directory. Since it is the

195

third version in the history of Enigma, the file is named

196

‘<samp>.enigmarc.xml</samp>’ by default.

197

198

We recommend that you backup this file, although it contains only a few data that you can

199

quickly reconfigure.

200

201

Since these preferences are quite specific for the operating system and configuration, you will

202

use a different version on each Enigma installation you have.

203

204

Mainly for Enigma developers, a switch exists ‘<samp>--pref</samp>’ (see section <a href="#Startup-Switches">Startup Switches</a>)

205

to rename this preferences file. By starting Enigma with a renamed preferences

206

file, a developer can temporarily use a complete separate configuration for

207

testing purposes without the danger of destroying his main configuration. The

208

developer may use it to start Enigma with a plain standard configuration for

209

testing purposes, too.

210

211

In all cases, a leading ‘<samp>.</samp>’ will hide the preferences filename.

212

213

214

</dd>

215

216

<dd>This is the main path to the user’s Enigma data. All updates, user-installed levels and user-

217

written levels, the user’s scores, history and usually the user’s screenshots and level previews,

218

are stored at this path.

219

220

A backup of this directory is mandatory!

221

222

The standard location is the directory ‘<samp>.enigma</samp>’ in your <code>HOME</code>

223

directory. For <code>HOME</code>-less Windows users, it is the folder

224

‘<samp>%APPDATA%\Enigma</samp>’, what resolves to the subfolder

225

‘<samp>Application Data\Enigma</samp>’ on XP/2000 or ‘<samp>AppData\Roaming\Enigma</samp>’ on

226

Vista/Windows 7 located within your user data folder.

227

228

This standard location of the user path is the location of logging and error

229

output files, too.

230

231

You can define your own path within the <a href="#User-Options">User Options</a>. By doing so, you can store your

232

Enigma user data on a memory stick or on a shared partition, and use them alternatively from

233

two Enigma installations.

234

235

236

</dd>

237

<dt> User Image Path</dt>

238

<dd>This is a second path to the user’s Enigma data, which you can use to access images such as

239

screenshots and thumbnails of levels. Usually this path is identical to the main ‘<samp>User

240

Path</samp>’.

241

242

Just in case you make many screenshots and have limited resources on the main

243

‘<samp>User Path</samp>’, you may want to store the images on another path. You can

244

define your own path within the <a href="#User-Options">User Options</a>.

245

246

247

</dd>

248

<dt> System Path</dt>

249

<dd>This path gives you the location of all system resources that are distributed with Enigma. Here

250

you will find the levels, libraries, etc. This is a first class address to look for examples if you start

251

writing your own levels.

252

253

254

</dd>

255

<dt> Resource Paths</dt>

256

<dd>This is a list of paths. The program looks up each version-independent resource on all paths in

257

this list, and loads from the first occurrence.

258

259

User data precedes system data; this way, updates on your user data path will win. Have a look

260

at this list if you are observing a difference between a source and the runtime behavior. You may

261

have looked at a file that another file had hidden on a preceding path in this list.

262

263

264

265

</dd>

266

267

<dd>This path shows the directory that contains the localization data.

268

269

</dd>

270

</dl>

271

272

Please note that some resources, like levels, may be zipped. In this case, a

273

resource that you expect to find at ‘<samp>dirname/filename</samp>’ may be stored in a zipfile

274

named ‘<samp>dirname.zip</samp>’. The path of the file within the zip can be either

275

‘<samp>dirname/filename</samp>’ or ‘<samp>./filename</samp>’. In case a resource is provided

276

in zipped and unzipped form, the plain file stored in a directory wins, since Enigma

277

assumes it to be an update to the zip.

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

294

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

295

296

</tr></table>

297

298

<h2 class="section">1.2 Startup Switches</h2>

299

300

Besides starting Enigma by clicking on an installation-provided icon or start

301

menu entry, you can start Enigma from a shell or commandline. This allows you

302

to add a selection of startup switches that are valid for just a single run.

303

304

For repeated usage of constant startup switches you can create an desktop icon

305

or start menu entry and append the startup switch to the target string of the

306

Enigma application executable.

307

308

The following list explains the supported user options. If an option is listed with a long name

309

preceded by two minus signs, and with a one-character abbreviation preceded by one minus

310

sign, use one of the notations, not both together; for example,

311

‘<samp>--data path</samp>’ or ‘<samp>-d path</samp>’.

312

313

314

<dt> --assert</dt>

315

<dd>A switch for Enigma developers that forces all debugging assertions, even

316

expensive ones, to be evaluated. The additionally evaluated checks look like

317

‘<samp>ASSERT(noAssert || long_lasting_check(), XLevelRuntime, "remark");</samp>’.

318

319

</dd>

320

321

<dd>A switch for Enigma developers that allows you to add an additional path to the

322

resource paths that precedes the system path (see section <a href="#Startup-Switches">Startup Switches</a>). A

323

developer can test an Enigma compilation, without installation, by calling it

324

from the shell with the current working directory on the main directory via

325

‘<samp>src/Enigma -d ./data</samp>’.

326

327

</dd>

328

329

<dd>Just lists the available startup switches to the output and terminate.

330

331

</dd>

332

333

<dd>A switch that allows you to override any other language preference. The language

334

is given in the common 2-character sequence as ‘<samp>fr</samp>’ for French or ‘<samp>ru</samp>’

335

for Russian.

336

337

</dd>

338

339

<dd>This switch turns on logging of internal information to the standard output.

340

Windows users will find an file called ‘<samp>Output.log</samp>’ in the standard

341

‘<samp>User Path</samp>’ folder. An additional file ‘<samp>Error.log</samp>’ lists severe

342

error messages.

343

344

The output will, for example, list the paths described in <a href="#Locating-Resources">Locating Resources</a>.

345

346

</dd>

347

<dt> --nograb</dt>

348

<dd>A switch for Enigma developers that causes Enigma not to grab the mouse. You can hardly

349

play a level in this mode, but it makes it possible to debug the

350

application in its core parts.

351

352

</dd>

353

<dt> --nomusic</dt>

354

<dd>Start Enigma without playing background music.

355

356

</dd>

357

<dt> --nosound</dt>

358

<dd>Start Enigma with sound being switched off.

359

360

</dd>

361

<dt> --pref -p filename</dt>

362

<dd>The name of an alternative preferences file without the leading dot for hidden

363

filenames. This switch is a pure Enigma developer support feature, as described

364

in <a href="#Locating-Resources">Locating Resources</a>.

365

366

</dd>

367

<dt> --pref -p dirpath</dt>

368

<dd>The path of an alternative directory that contains the standard named preference

369

file ‘<samp>.enigmarc.xml</samp>’. If no preference file exists or the directory does

370

not yet exist they are created. On creation of the preference file the user data

371

path is set to the given dirpath per default. This allows to store all Enigma

372

user data in a single directory that can be stored anywhere, e.g. on a USB stick.

373

You always need to call Enigma with the above switch to use this new set up.

374

Remember that a path with spaces needs to be quoted.

375

376

</dd>

377

<dt> --redirect</dt>

378

<dd>Redirect the ‘<samp>stdout</samp>’ and ‘<samp>stderr</samp>’ to files named ‘<samp>Output.log</samp>’

379

and ‘<samp>Error.log</samp>’ on the standard user path (see section <a href="#Locating-Resources">Locating Resources</a>).

380

For Windows this option is always <code>true</code>, but the usage of this option

381

is useful on any operating system if Enigma is started via a desktop icon or

382

a menu button.

383

384

</dd>

385

<dt> --robinson</dt>

386

<dd>Disable all connections to the internet. No automatic updates will take place

387

and all user initiated requests that would require an internet connection will

388

fail with an error message.

389

390

</dd>

391

<dt> --showfps</dt>

392

<dd>Show the framerate (FPS) during the game.

393

394

</dd>

395

<dt> --version</dt>

396

<dd>Just print the version number to the output and terminate.

397

398

</dd>

399

<dt> --window -w</dt>

400

<dd>Start Enigma in window mode instead of screen mode.

401

402

</dd>

403

</dl>

404

405

Enigma interprets all further arguments supplied on the commandline as level file

406

addresses. You can use absolute or relative addresses to level files stored

407

on your computer. Adding url’s to levels stored in the Internet is also possible.

408

409

A Unix user may start Enigma with the following command:

410

411

<code>enigma --log ~/mylevel.xml http://somewhere.com/netlevel.xml</code>

412

413

A Windows user may start Enigma from the command line (please adjust the Enigma

414

installation path):

415

416

<code>C:\Programs\Enigma\enigma.exe --log demo_simple.xml</code>

417

418

You will find these levels in the levelpack called ‘<samp>Startup Levels</samp>’, which is

419

only visible by default if you supplied levels on the commandline.

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

436

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

437

438

</tr></table>

439

440

<h2 class="section">1.3 User Options</h2>

441

442

443

<dt> Ratings update</dt>

444

<dd>Please retain this option on the value ‘<samp>Never</samp>’ until release of Enigma 1.00.

445

446

</dd>

447

448

<dd>Enter your user name, which Enigma will attach to your scores. Please look at

449

the Enigma home page for user names already in use and choose a new, unique name.

450

You can change your user name at anytime without losing any of your

451

scores.

452

453

</dd>

454

455

<dd>This textfield allows you to define an arbitrary directory for your Enigma user

456

data as described in <a href="#Locating-Resources">Locating Resources</a>.

457

458

Deletion of the string resets the path to the default.

459

460

Enigma activates the new path when you leave the options menu. Though it stores all files

461

directly to the new path, and will still find files on the old path, you may want to quit Enigma

462

immediately and first copy/merge the old directory to the new location. This copy of your old

463

data is necessary, since with the next start, Enigma will locate user data at the new location

464

exclusively.

465

466

</dd>

467

<dt> User image path</dt>

468

<dd>This textfield allows you to define an arbitrary directory for your Enigma user

469

image data as described in <a href="#Locating-Resources">Locating Resources</a>.

470

471

Deletion of the string resets the path to the default.

472

473

Enigma activates the new path when you leave the options menu. Though it has stored all files

474

directly to the new path and files will still be found on the old path, you may want to quit

475

Enigma immediately and first copy/merge the old directory to the new location. This copy of

476

your old data is necessary, since with the next start, Enigma will locate user data at the new

477

location exclusively.

478

479

</dd>

480

</dl>

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

498

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

499

500

</tr></table>

501

502

<h2 class="section">1.4 Inventory Console</h2>

503

504

The lower right window area that usually shows the inventory items and scrolls

505

the texts of activated document items allows the user to reread previous

506

document texts, to enter textual commands and to reissue previous commands.

507

508

You can issue a command by usage of the keyboard. Just enter the command string

509

and activate the command by a finishing <return> stroke. The following

510

commands are supported:

511

512

513

514

<dd>List all public available commands.

515

</dd>

516

<dt> abort</dt>

517

<dd>Abort level and return to level selection menu. Same as <Alt X>

518

</dd>

519

<dt> April 1st</dt>

520

<dd>Just a joke.

521

</dd>

522

<dt> cheats</dt>

523

<dd>List level developer cheat commands for fast testing.

524

</dd>

525

<dt> collision</dt>

526

<dd>Developer cheat that disables collisions between stones and marbles or pearls.

527

Once used no score will be recorded if the level is successfully finished.

528

</dd>

529

530

<dd>Restart level in easy difficulty mode.

531

</dd>

532

<dt> find search_string</dt>

533

<dd>Searches levels in all levelpacks that contain matching string in either

534

the level’s title, author’s name or the file name.

535

</dd>

536

537

<dd>Developer cheat that protects the actors assigned to the current player like

538

the activation of an <a href="#it_005fumbrella">it_umbrella</a> does. Once used no score will be

539

recorded if the level is successfully finished.

540

</dd>

541

542

<dd>Switch to world record hunting mode. Same as toggling the left most button

543

in the level selection menu to the world icon.

544

</dd>

545

546

<dd>Show info about level like the levelpack, position within levelpack, the file

547

location, the title, author, version and the level internal id.

548

</dd>

549

<dt> jumpto levelpack,position</dt>

550

<dd>Directly start the given level. The levelpack is identified by its title. The

551

position is the number within the levelpack. E.g. <code>jumpto Enigma IV,33</code>.

552

</dd>

553

<dt> nohunt</dt>

554

<dd>Switch off the world record hunting mode. Same as toggling the left most button

555

in the level selection menu to the marble icon.

556

</dd>

557

<dt> regular</dt>

558

<dd>Restart level in regular difficulty mode

559

</dd>

560

<dt> restart</dt>

561

<dd>Restart level in currently selected difficulty mode.

562

</dd>

563

<dt> suicide</dt>

564

<dd>Kill actors, but continue level if possible. Same as <F3>.

565

</dd>

566

</dl>

567

568

Both, the commands and the displayed document text have a history. You recall

569

the history by usage of the up and down arrows.

570

571

<ul>

572

<li> inventory –> jump to start

573

</li><li> command #10, oldest command in history

574

</li><li> command #9

575

</li><li> …

576

</li><li> command #2

577

</li><li> command #1, last executed command

578

</li><li> command under edition, just if the last edited command has not been executed

579

</li><li> inventory <– start

580

</li><li> document #1, last viewed document

581

</li><li> document #2, previous viewed document

582

</li><li> …

583

</li><li> document #n, first viewed document

584

</li><li> level title, subtitle, author, as shown on level start

585

</li><li> inventory –> jump to start

586

</li></ul>

587

588

Starting with the inventory item display the up arrow shows the previously

589

submitted commands. Just by another <return> you can reissue a command.

590

The history will be resorted with the last command at the position direktly

591

above the inventory. You can edit history commands anytime like you can insert

592

a new command. If you do not finish a command by a <return> the string will

593

still be recorded and presented as the first command above the inventory. The

594

command history is persistent.

595

596

The document history can be recalled by usage of the down arrow. All level

597

documents previously displayed can be redisplayed. Additionally the initial

598

level info displayed on the level start can be read again.

599

600

Both histories revolve to the item inventory when the up or down keys are

601

used beyond the oldest command or message.

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

618

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

619

620

</tr></table>

621

622

<h2 class="section">1.5 Level Info</h2>

623

624

625

For every level, Enigma manages more data than can be displayed in the level menu. You can

626

view them all with the levelinspector. You can call this special menu from within the level menu

627

by right or control clicking on the level icon.

628

629

Besides title and author, Enigma provides information concerning a public rating of the level,

630

different score values of interest, details on the level version, the level file location and more.

631

Additionally, the levelinspector allows you to enter personal annotations for a level. You can

632

review any screenshots you made for this level directly from the levelinspector, too.

633

634

635

<tr><td align="left" valign="top"><a href="#Public-Ratings">1.5.1 Public Ratings</a></td><td>  </td><td align="left" valign="top">

636

</td></tr>

637

<tr><td align="left" valign="top"><a href="#Scores">1.5.2 Scores</a></td><td>  </td><td align="left" valign="top">

638

</td></tr>

639

<tr><td align="left" valign="top"><a href="#Versions">1.5.3 Versions</a></td><td>  </td><td align="left" valign="top">

640

</td></tr>

641

<tr><td align="left" valign="top"><a href="#Private-Annotations-and-Ratings">1.5.4 Private Annotations and Ratings</a></td><td>  </td><td align="left" valign="top">

642

</td></tr>

643

<tr><td align="left" valign="top"><a href="#Screenshots">1.5.5 Screenshots</a></td><td>  </td><td align="left" valign="top">

644

</td></tr>

645

</table>

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

662

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

663

664

</tr></table>

665

666

<h3 class="subsection">1.5.1 Public Ratings</h3>

667

668

Most levels are rated within five different categories:

669

<ul>

670

<li>

671

int = Intelligence

672

673

</li><li>

674

dex = Dexterity

675

676

</li><li>

677

pat = Patience

678

679

</li><li>

680

kno = Knowledge of Enigma

681

682

</li><li>

683

spe = Speed and Speed control

684

685

</li></ul>

686

687

To distinguish the ratings from their everyday-meanings, we use the following abbreviations for

688

the ratings. Each of these categories takes values between 1 (easy) and 5 (difficult), except kno,

689

which can also be 6 (unique mechanism).

690

691

Please bear in mind that it’s not simple to retain the

692

following definitions in each of nearly 750 cases, so there

693

might be (will be) deviations from them in single levels.

694

695

Intelligence (int)

696

697

This rating is intended to measure the creativity, planning and analytic requirements needed to

698

solve the level. Intelligence is a very difficult concept in itself, and thus at first not easy to rate or

699

to grasp. Consequently, a fixed definition of the five rating-degrees not only helps, but is

700

essential in the rating process. So, assume you know everything about the single elements of a

701

level. Then ask yourself these questions:

702

<ul>

703

<li>

704

Can I see the solution at once? Yes -> int 1

705

706

</li><li>

707

Do I only have to orient myself, for example, testing the exits of wormholes or to see the

708

function of a switch? -> int 2

709

710

</li><li>

711

Is there a standard algorithm to solve the problem, like in a maze, or

712

searching for a hidden item? -> int 3

713

714

</li><li>

715

Neither trial-and-error nor standard algorithms work; is it a simple

716

kind of code or does it require advance planning? -> int 4

717

718

</li><li>

719

Is it a difficult code, pattern or causal chain? -> int 5

720

721

</li></ul>

722

723

High values for intelligence are typically puzzles.

724

int-ratings do not accumulate; the most difficult puzzle

725

itself already determines the rating.

726

727

Dexterity (dex)

728

729

You can solve many levels either by accuracy or by patience. In our context, we do not mean

730

dexterity in the sense of accuracy to avoid impatience, but accuracy to avoid death. So it focuses

731

on the lethal positions in a level, not only death-stones and abysses, but also casualties like

732

pushing a stone accidentally into an unreachable corner.

733

734

<ul>

735

<li>

736

It doesn’t matter what I touch, this level is damn-proof. -> dex 1

737

738

</li><li>

739

Well, there are lethal positions I shouldn’t move the level into, but

740

they are not difficult to overcome. -> dex 2

741

742

</li><li>

743

Comparable to a single row with an abyss left and right. -> dex 3

744

745

</li><li>

746

Comparable to pushing a stone to the right with an abyss on

747

the left, or a single row with death-stones left and right. ->

748

dex 4

749

750

</li><li>

751

Needs lots of attempts to succeed. -> dex 5

752

753

</li></ul>

754

755

In contrast to the int-rating, dex might accumulate: A level with many situations,

756

each of dex 3, can add up to dex 4 or even 5. This way, you can achieve dex 5.

757

Rotors in a level also contribute to dex and to the

758

speed-rating, spe. Thus, levels with a high dex-spe-combination are

759

mostly action-driven, whereas a high dex-pat-combination typically is

760

a dangerous maze.

761

762

Patience (pat)

763

764

Patience is a relatively subjective rating, and refers mostly to “felt time”, how long it felt to

765

complete the level. So two levels with same mechanics can have different pat-values, e.g., if one

766

level has a nicer design or shows the progress of the level in some way, like the number of

767

opened oxyds. It explicitly includes having to restart the level repeatedly; not the time in the

768

lower left corner or the score is crucial, but the complete “felt time” needed to solve the level,

769

starting from the first look at it.

770

<ul>

771

<li>

772

I solved the level right after understanding it. -> pat 1

773

774

</li><li>

775

I needed some time, but it wasn’t boring. -> pat 2

776

777

</li><li>

778

Okay, it took some minutes, but the landscape is nice ... -> pat 3

779

780

</li><li>

781

I know what to do, but it doesn’t seem to end. -> pat 4

782

783

</li><li>

784

This level really requires discipline. -> pat 5

785

786

</li></ul>

787

788

A high number of oxyds can heighten the pat-value and also lower it: If the player has to

789

traverse the level several times to open matching pairs of oxyds, it is definitely pat-heightening.

790

However, if oxyds are arranged to mark the progress of the player, and act as a kind of small

791

reward within the level, they can lower the pat-value. It’s the same with a high number of doors:

792

The arrangement is the critical factor.

793

794

High pat-values are typically mazes. In combination with int 3, a high

795

pat-value can indicate a hidden item or a hollow stone. pat-values

796

involve the whole level, so they can’t accumulate.

797

798

Knowledge of Enigma (kno)

799

800

The kno-rating mostly takes on the function and interactions of single

801

objects in the game, like stones, floors, items, and actors. However,

802

in some cases it also deals with special techniques. The guideline is

803

the “Advanced Tutorial”, which defines kno 3. kno 4 corresponds to

804

standard objects that aren’t shown in the tutorial; kno 5 requires a

805

deeper knowledge of the game internals. Finally, kno 6 indicates

806

special mechanisms, that are seldom encountered or unique. The overall kno-rating

807

of a level equals that of the most difficult object or technique (and

808

thus is non-accumulative):

809

<ol>

810

<li>

811

Moving a single marble on normal floors, normal walls, oxyds,

812

stones that look like oxyds, death-stones, water, an abyss, documents,

813

using the inventory, static gravity, visible gradients.

814

815

</li><li>

816

Pushing stones, simple Sokoban-tricks, bridge-building in water

817

and an abyss, connected puzzle-stones, moving more than one marble,

818

meditations, grates, rotors and tops, hidden gradients, triggers and

819

switches, doors, holes (not made by dynamite), swamp, floppies and

820

st-floppy, keys and locks, coins and slots, cracks, timer-stones.

821

822

</li><li>

823

Different floors can have different fraction and mouseforce, space,

824

ice, inverted floor, some stones sink while others swim, black grates

825

that hold rotors and tops away, dynamite, dynamite-breakable stones,

826

spade, boulders, magic-wand to change boulder-direction, boulders sink

827

into an abyss, sheets of glass, spoon, actors and items may hide under

828

movable stones, small not-killer whiteballs, coloured one-way-streets,

829

actorimpulse-stones (“bumpers”), rotors can fly over an abyss,

830

quake-stones, swords and knights, lasers, static and movable mirrors,

831

item- and coin-transformations by pushing stones over them and by

832

using lasers, umbrellas protect in an abyss, hammer and breakable stones

833

(although not in the tutorial).

834

835

</li><li>

836

Bridge-building in swamps, rubber-bands, rubber-band-stones,

837

scissor-stones, unconnected puzzle-stones, exploding puzzle-stones,

838

turning puzzle-stones (with and without a magic wand), springs (both

839

types, on the floor and hole-kind springs like in “Upstream

840

Journey”), thieves, three-part shogun-stones, invisible stones,

841

hollow stones, chameleon-stones, items hidden under chameleon stones,

842

stones that aren’t what they seem (e.g., fake-death-stones), wormholes,

843

magnets, using F3 for a restart to solve a level, yin-yangs,

844

one-color-, yin-yang- and inverted yin-yang-stones, stones breakable

845

by only one color, killer-balls, swap-stones, brush and paintable

846

stones, changing one-way-streets with a magic wand, changing stones to

847

glass with a magic wand, impulse-stones (movable, static and hollow),

848

black and white bombs, bomb-stones, fire, extinguishers,

849

rotator-stones, yellow anti-swapping stones, mines, flags, seeds,

850

weights, putting objects under one-way-streets and other hollow

851

stones, electric stones, turnstiles, mailing and pipes, rings (single

852

and multiplayer), volcanos, bags, randomizers (as possible effect of a

853

switch), horses (the actors) and horse-passing stones, pins, bananas, cherries

854

can make you invisible, surprise-item.

855

856

</li><li>

857

Cracks, floor-springs, wormholes, etc., are all items, seeds can grow

858

inside stones, the laser is blocked by all items, killer-balls don’t sink

859

in water, “Space Meditation”-kind collisions, holding down the

860

mouse-button, invisibility lets you go through glass, jumping over

861

lasers ...

862

863

</li><li>

864

Spitter-stones, surprise-stones, levels like “Enigris” or “Flood

865

Gates” ...

866

867

</li></ol>

868

869

kno 6 does not necessarily mean that this level is difficult to

870

understand; the unique mechanism or object might also be very

871

intuitive, like in “Flood Gates”.

872

873

Speed and speed control (spe)

874

875

The spe-value corresponds not only to the maximum speed a level

876

requires (like you need to run away from a rotor), but also the

877

degree of control a player has over his mouse while moving it;

878

excellent examples for this are “Mourning Palace” and the middle

879

part of “Sacrifice”. This involves moving the mouse at a constant

880

velocity for a long time, as well as correctly estimating the speed

881

that’s needed in a certain task, like shattering a sheet of glass.

882

883

<ol>

884

<li>

885

No time limit.

886

887

</li><li>

888

You shouldn’t stop for too long. For example, something slow might

889

be chasing you.

890

891

</li><li>

892

There is an appropriate time limit or speed control task. This can

893

be a single, not-too-fast rotor in an open area.

894

895

</li><li>

896

Don’t stop! Examples include difficult timing-tasks as well as a single

897

fast rotor or several slower ones.

898

899

</li><li>

900

Hurry Up! Whereas spe 4 is meant to be difficult, but obviously

901

solvable in not too many attempts, spe 5 is everything beyond this.

902

903

</li></ol>

904

905

The spe-rating again is cumulative, since many slow rotors can add up

906

to spe 3 or 4, or a combination of many slow time-switches to be

907

pressed in a certain order can create a horrible task. In contrast to

908

the other categories, for which the average is near 3 (or between 3

909

and 4 for kno), most levels are definitely

910

spe 1. So, the spe-rating is more a supplement to the three

911

core-ratings int, dex and pat.

912

913

Combinations of ratings

914

915

Sometimes, it can be interesting to have a single value to measure the difficulty of a level. To

916

calculate such a universal rating, a simple possibility is choosing a linear combination of the 5

917

single ratings, weighted with appropriate weights. These weights should correspond to the

918

difficulty a single category adds to the universal difficulty. Yet you should also choose these

919

weights carefully to avoid number-theoretic obstructions (e.g., when all weights are even except

920

for the spe-rating, then there will be a visible difference in the distribution of even and odd

921

universal ratings, which can be very misleading). A working, and very interesting linear

922

combination, is the following, which has been applied in the reordering process:

923

924

925

<table><tr><td> </td><td><pre class="example">universal difficulty = 7*int + 6*dex + 4*pat + 3*kno + 4*spe - 23

926

</pre></td></tr></table>

927

928

This has a special property, in that it takes relatively broad and continuously distributed values

929

between 1 (all ratings 1) and 100 (all ratings 5, kno 6) and emphasizes the most difficult

930

categories, intelligence and dexterity. However, some very low or very high values cannot

931

appear in this combination, such as 2 or 99. Other combinations lead to full but narrow, or to

932

broad but noncontinuous spectra.

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

949

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

950

951

</tr></table>

952

953

<h3 class="subsection">1.5.2 Scores</h3>

954

955

The score columns show your and some comparison values for the difficult and

956

for the easy mode, if the levels supports it.

957

958

The world record is the best score that was retransmitted to the Enigma team.

959

The world record holders are listed below.

960

961

The PAR value is the “professional average rating” of the level. It is the harmonic average of all

962

scores that Enigma players have retransmitted. However, we take into account only scores from

963

players who have solved a certain number of levels. Opposed to the world record, which will be

964

very difficult to gain, the PAR value is a much more realistic aim for an ambitious player. If you

965

are equal or better than PAR, the levels are marked with a speeding blackball within the level

966

menu.

967

968

The author’s value is another reference score. Most authors are not keen on holding the world

969

record of their own levels. However, they will likely know the fastest way to solve the level. If

970

your score is much higher than the author’s score, a simpler solution to solve the level may

971

exist.

972

973

The solved number is the number of players who solved this level in the given

974

score version.

975

976

The solved percentage is the relation of the number of players who solved this

977

level to the number of players who retransmitted scores. Actually, we take into

978

account only those players who could have solved the level. For example, players

979

who did retransmit scores before the level was written, without updating

980

afterwards, are not taken into account. A low percentage is a hint that a level

981

is not easy to solve.

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

998

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

999

1000

</tr></table>

1001

1002

<h3 class="subsection">1.5.3 Versions</h3>

1003

1004

The version column shows detailed information about the level. Read the chapter Level

1005

Basics node see section <a href="#g_t_003cversion_003e"><version></a> and see section <a href="#g_t_003cmodes_003e"><modes></a> for an explanation of the

1006

values.

1007

1008

For you as a player, the ‘<samp>Score</samp>’ version number can be interesting.

1009

A level you had solved with a certain score may appear with a red triangle in the level menu in

1010

an updated Enigma release of the level. Although the level menu displays the medals showing

1011

that you solved the level, it will not display the score values anymore. This is due to an

1012

incompatible level update that requires a new solution with different, incomparable score

1013

values. The author will increase the score version number in such a case.

1014

1015

1016

1017

1018

1019

1020

1021

1022

1023

1024

1025

1026

1027

1028

1029

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

1030

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

1031

1032

</tr></table>

1033

1034

<h3 class="subsection">1.5.4 Private Annotations and Ratings</h3>

1035

1036

This textfield allows you to enter an annotation for a level that you can review

1037

on later replays. Note that the current textfield is limited (it may not allow you to enter all

1038

characters, and needs the mouse cursor to remain within its boundaries). Yet it should work for

1039

entering short annotations that may be very useful later.

1040

1041

Enigma stores annotations in your private applications ‘<samp>state.xml</samp>’ file. It permits one

1042

annotation per level, independent of the level version.

1043

1044

You may rate the levels, too. Just click on the ratings button. Values go from

1045

0 to 10 with an additional ‘<samp>-</samp>’ for abstention. 0 stands for a poor level

1046

that you think is not worth playing, 5 for an average level and 10 for the

1047

ultimate, best levels. Try to use all values in your ratings.

1048

1049

Enigma stores the ratings with the scores and evaluates them anonymously. Enigma displays

1050

the resulting average rating of all users, for your information. Note that different ratings are

1051

possible for different score versions of the same level, because levels may improve as a result of

1052

suggestions by users. If you do not re-rate a new version of a level, Enigma inherits your rating

1053

from a previous version.

1054

1055

1056

1057

1058

1059

1060

1061

1062

1063

1064

1065

1066

1067

1068

1069

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

1070

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

1071

1072

</tr></table>

1073

1074

<h3 class="subsection">1.5.5 Screenshots</h3>

1075

1076

While playing a level, you can make screenshots by pressing <F10>. You can make

1077

several screenshots in sequence for documentation purposes. Enigma will store each

1078

with a unique image filename. Using the level inspector, you can view the screenshots directly

1079

from within Enigma. Just click on the screenshot button to

1080

view the first image.

1081

1082

Because any buttons would disturb the view of a screenshot, all functions are keyboard

1083

commands. Press <F1> to get a help screen. <ESC> returns to the level inspector.

1084

<Page Up> and <Page Down> will show the previous and next screenshot.

1085

If you scroll down behind the last screenshot, the “missing” screenshot file is named.

1086

This may be a useful hint as to where to search the other screenshot files on your

1087

‘<samp>user image path</samp>’ (see section <a href="#Locating-Resources">Locating Resources</a>).

1088

1089

1090

1091

1092

1093

1094

1095

1096

1097

1098

1099

1100

1101

1102

1103

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

1104

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

1105

1106

</tr></table>

1107

1108

<h2 class="section">1.6 Handicap and PAR</h2>

1109

1110

As PAR (see section <a href="#Scores">Scores</a>) describes the difficulty of a level, the handicap ‘<samp>hcp</samp>’

1111

describes your ability to solve levels in PAR. The handicap is always related

1112

to a levelpack or group of levelpacks. You can see your handicap for each levelpack in the level

1113

menu, if you select the PAR mode by clicking on the lower

1114

left button until the speeding black marble appears. The value is displayed in

1115

the upper right corner, with the number of levels you solved in PAR.

1116

1117

The handicap is similar to the golfer’s handicap. A low value is better than a

1118

high value. If you solve all levels exactly in PAR, your handicap will be 0. If

1119

you are even better than PAR, your handicap will be negative. Players can use

1120

this value to compare their overall abilities.

1121

1122

Just for those of you that want to know the details of this score rating system

1123

of PAR and handicap, here is some additional information, which others may skip and

1124

continue with the next chapter <a href="#Levelpack-Basics">Levelpack Basics</a>.

1125

1126

We request all users to send their scores. All scores are evaluated for world

1127

records and counts of level solution rates and numbers.

1128

1129

However, for the PAR calculation, we take into account only scores from users who have solved

1130

more than a certain percentage of levels (currently about 10% of the levels). For every level, we

1131

calculate the harmonic average of the scores of these

1132

‘<samp>professionals</samp>’. We take professionals who did not solve a level into account with the

1133

10-fold world record score. The harmonic average calculates as

1134

1135

harm.avg. = N / (sum_[j=1..N] 1/score_j) )

1136

1137

It weights small (short) times with a greater weight than large (long) solution times.

1138

1139

The handicap is a sum of values that describe your scores in relationship to the PAR value of a

1140

level. Since it has to take into account that you have no score at all or that no PAR value exists,

1141

we apply some exception rules to the addends:

1142

1143

<table>

1144

<tr><td width="10%">•</td><td width="15%">+ 1.0</td><td width="75%">for each unsolved level</td></tr>

1145

<tr><td width="10%">•</td><td width="15%">+ log10(score/par)</td><td width="75%">for each solved level with existing par if score >= par</td></tr>

1146

<tr><td width="10%">•</td><td width="15%">+ 0.7</td><td width="75%">as upper limit for each solved level with existing par if score >= par</td></tr>

1147

<tr><td width="10%">•</td><td width="15%">+ log2(score/par)</td><td width="75%">for each solved level with existing par if score < par</td></tr>

1148

<tr><td width="10%">•</td><td width="15%">- 3.0</td><td width="75%">as lower limit and as value for levels without par</td></tr>

1149

</table>

1150

1151

Note that each score that is better than PAR results in a negative addend and

1152

thus reduces your handicap. For a levelpack with 100 levels, the handicap will

1153

be in the range of +100 to -300. For levelpacks with more or fewer levels, Enigma

1154

will scale the sum by a factor 100/size to result in comparable handicap values.

1155

Handicaps are stated with one digit behind the decimal point.

1156

1157

1158

1159

1160

1161

1162

1163

1164

1165

1166

1167

1168

1169

1170

1171

1172

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

1173

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

1174

1175

</tr></table>

1176

1177

<h2 class="section">1.7 User Sound Sets</h2>

1178

1179

(The following information accounts only for Enigma 1.01 and above.)

1180

Sound effects are triggered by so-called ‘<samp>sound events</samp>’. These sound

1181

events usually have a name (like ‘<samp>dooropen</samp>’) and an associated location

1182

(the coordinates of the door) which affects the way a sound effect is

1183

played. The collection of all sound files, their assignment to sound events,

1184

and some additional information how to play them is called a ‘<samp>sound set</samp>’.

1185

1186

You can use own sound files to create own sound sets for Enigma, and choose

1187

among them in the options menu (entry ‘<samp>Sound set</samp>’). You can distribute

1188

these sound sets under your own choice of license and install sound sets from

1189

other users. There is no internal limit for the number of installed sound sets.

1190

1191

The sound event is converted into a real sound effect using tables, you can

1192

find such tables in the ‘<samp>data/sound-defaults.lua</samp>’ file and in the empty

1193

sample file at ‘<samp>reference/soundset.lua</samp>’. Each entry in these tables is

1194

either a string like ‘<samp>enigma/st-coinslot</samp>’, which is interpreted as the

1195

file ‘<samp>soundsets/enigma/st-coinslot.wav</samp>’ with some default properties, or a

1196

list of sound attributes enclosed in curly braces. Sound events triggered by a

1197

<a href="#sound">sound</a> message are converted the same way. Here is an example of such an

1198

entry:

1199

1200

<table><tr><td> </td><td><pre class="example">dooropen = { file="my_soundset/open-door", volume=0.9, priority=4 },

1201

</pre></td></tr></table>

1202

1203

The meaning of these attributes is as follows:

1204

1205

<ul>

1206

<li> ‘<samp>file</samp>’

1207

Path and name of the sound file for this event, without the ‘<samp>.wav</samp>’

1208

extension.

1209

1210

</li><li> ‘<samp>volume</samp>’

1211

The sound volume: 1.0 is default, 0.0 is silent.

1212

1213

</li><li> ‘<samp>priority</samp>’

1214

If many effects are active at the same time, high-priority

1215

effects can replace lower-priority effects. Use an integer

1216

between 1 and 10 (default 1). This property does not yet

1217

work with Enigma 1.01.

1218

1219

</li><li> ‘<samp>global</samp>’

1220

Either ‘<samp>true</samp>’ or ‘<samp>false</samp>’. If true, no stereo effects are

1221

applied and there is no attenuation. Used for menu sound,

1222

level end sounds, etc. Default is ‘<samp>false</samp>’.

1223

1224

</li><li> ‘<samp>loop</samp>’

1225

‘<samp>true</samp>’ or ‘<samp>false</samp>’. If true, the sound repeats infinitely

1226

until canceled. Default is ‘<samp>false</samp>’.

1227

1228

</li><li> ‘<samp>damp_max</samp>’, ‘<samp>damp_inc</samp>’, ‘<samp>damp_mult</samp>’, ‘<samp>damp_min</samp>’, ‘<samp>damp_tick</samp>’

1229

Parameters for sound damping. Sounds from noisy objects like light passengers

1230

are damped to reduce the noise. For this, the sound event’s frequency is

1231

estimated. ‘<samp>damp_max</samp>’ calibrates the maximal damping factor (high means

1232

quiet), ‘<samp>damp_inc</samp>’ how fast the damping accumulates, ‘<samp>damp_mult</samp>’ is an

1233

overall factor, ‘<samp>damp_min</samp>’ defines a lower bound for the damping entries

1234

(beyond which they are removed from memory) and ‘<samp>damp_tick</samp>’ the factor

1235

that’s applied all 0.1 seconds. See ‘<samp>sound.hh</samp>’ for details.

1236

Defaults: 10.0, 1.0, 1.0, 0.5, 0.9.

1237

1238

</li></ul>

1239

1240

To design a new sound set, proceed as follows:

1241

1242

<ol>

1243

<li>

1244

Create a new folder containing a copy of the sample file ‘<samp>soundset.lua</samp>’

1245

and the wav files you want to use.

1246

1247

</li><li>

1248

Move this new folder into Enigma’s "soundsets" folder in your user path.

1249

(Possibly you have to create it.) The directory structure should look

1250

something like this:

1251

1252

<table><tr><td> </td><td><pre class="example">(user path)/soundsets/my_sounds/

1253

/soundset.lua

1254

/high_pitch.wav

1255

/soundfile_13.wav

1256

...

1257

</pre></td></tr></table>

1258

1259

</li><li>

1260

Run Enigma and choose ‘<samp>My Soundset</samp>’ in the options menu. Since this file’s

1261

sound set does not map any sound effect to a wav file, you should hear nothing.

1262

1263

</li><li>

1264

Edit the contents of ‘<samp>soundset.lua</samp>’ to your liking. You can access the

1265

default sound files, e.g.:

1266

1267

<table><tr><td> </td><td><pre class="example">...

1268

coinsloton = { file="enigma/st-coinslot" },

1269

...

1270

</pre></td></tr></table>

1271

1272

When using own sound files, remember to add the subfolder, like in

1273

1274

<table><tr><td> </td><td><pre class="example">...

1275

coinsloton = { file="my_sounds/soundfile_13" },

1276

...

1277

</pre></td></tr></table>

1278

1279

No extension ".wav"! It’s added automatically. Make sure that the

1280

extension is in lower case letters.

1281

1282

</li><li>

1283

Replace ‘<samp>MY_SOUNDSET</samp>’ by a suitable variable name, and ‘<samp>My Soundset</samp>’

1284

by the name you want to see in the sound options menu. Remember to

1285

make it short enough to fit on the button. The three identifiers variable,

1286

button name, directory name need not have the same names, but it eases the life

1287

of other developers to give them similar names that uniquely determine the

1288

sound set.

1289

1290

</li></ol>

1291

1292

Remember to choose the sound set in the options menu anew each time you change

1293

its name. And always shut down Enigma before changing sound sets, new sounds

1294

are not recognized during runtime.

1295

1296

Feel free to zip and distribute the whole directory containing your

1297

sounds and the ‘<samp>soundset.lua</samp>’ file. You can install a downloaded zipped

1298

sound set simply by unpacking it and placing it into the

1299

‘<samp>soundsets</samp>’-subdirectory of your user path. Make sure that the

1300

‘<samp>soundset.lua</samp>’ is always exactly one subdirectory below ‘<samp>soundsets</samp>’.

1301

Deinstall a user sound set simply by deleting its directory. Renaming the

1302

directory does not suffice – you have to rename the ‘<samp>soundset.lua</samp>’ if you

1303

want to hide a sound set from Enigma. This can be advantageous if you use

1304

interdependent sound sets (sound sets that share sound files) and want to

1305

deactivate just one of them.

1306

1307

1308

1309

1310

1311

1312

1313

1314

1315

1316

1317

1318

1319

1320

1321

1322

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

1323

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

1324

1325

</tr></table>

1326

1327

<h1 class="chapter">2. Levelpack Basics</h1>

1328

1329

Knowing the basics of running Enigma, you may wonder how levels are organized in

1330

levelpacks and how you can add levels or complete levelpacks to Enigma.

1331

1332

1333

1334

1335

1336

Levelpacks are sorted collections of levels that consist of an index and optional

1337

attached level sources. Not all level sources of a levelpack have to be included

1338

within the levelpack itself. A levelpack can crossreference levels stored in

1339

other levelpacks. If a levelpack has no level sources of its own and consists only

1340

of crossreferences, we speak of a crossindex, since just a single index file represents the

1341

levelpack.

1342

1343

These definitions suit all versions of Enigma well. However, up to Enigma 0.92, levelpacks

1344

needed to be manually edited, and the registration of levelpacks was a little bit cryptic. Thus, we

1345

decided to rewrite the complete levelpack system for Enigma 1.0, and tried to make it versatile

1346

and easy to use. We did set up the following aims:

1347

1348

<ul>

1349

<li>

1350

an ‘<samp>Auto</samp>’ levelpack that allows level addition by drag and drop of the

1351

level source

1352

1353

</li><li>

1354

levelpack addition simply by copying the files to the userpath

1355

1356

</li><li>

1357

autodetection of all levelpacks without editing any registration files

1358

1359

</li><li>

1360

commandline-supplied levels as a standard levelpack

1361

1362

</li><li>

1363

a ‘<samp>History</samp>’ levelpack with crossreferences of last-played levels

1364

1365

</li><li>

1366

level search results as a levelpack of crossreferences

1367

1368

</li><li>

1369

zipped levelpacks that are just archives of levelpack directories and their files

1370

1371

</li><li>

1372

grouping of levelpacks in the menu

1373

1374

</li><li>

1375

integrated composer to create and modify new levelpacks

1376

1377

</li><li>

1378

updates of levelpacks without updating Enigma itself

1379

1380

</li><li>

1381

automatic conversion of Enigma 0.92 levelpacks

1382

1383

</li></ul>

1384

1385

Some of these features work seamlessly. You can use them immediately from the

1386

levelpack menu. For others, you may need to know where to place files. We will

1387

explain these details in the following sections:

1388

1389

1390

<tr><td align="left" valign="top"><a href="#Getting-Started-with-Levelpacks">2.1 Getting Started with Levelpacks</a></td><td>  </td><td align="left" valign="top">

1391

</td></tr>

1392

<tr><td align="left" valign="top"><a href="#Converting-0_002e92-Levelpacks">2.2 Converting 0.92 Levelpacks</a></td><td>  </td><td align="left" valign="top">

1393

</td></tr>

1394

<tr><td align="left" valign="top"><a href="#Zip-Levelpacks">2.3 Zip Levelpacks</a></td><td>  </td><td align="left" valign="top">

1395

</td></tr>

1396

<tr><td align="left" valign="top"><a href="#Grouping-and-Sorting-Levelpacks">2.4 Grouping and Sorting Levelpacks</a></td><td>  </td><td align="left" valign="top">

1397

</td></tr>

1398

<tr><td align="left" valign="top"><a href="#Creating-New-Levelpacks">2.5 Creating New Levelpacks</a></td><td>  </td><td align="left" valign="top">

1399

</td></tr>

1400

<tr><td align="left" valign="top"><a href="#Modifying-and-Deleting-Levelpacks">2.6 Modifying and Deleting Levelpacks</a></td><td>  </td><td align="left" valign="top">

1401

</td></tr>

1402

<tr><td align="left" valign="top"><a href="#Composing-Levelpacks">2.7 Composing Levelpacks</a></td><td>  </td><td align="left" valign="top">

1403

</td></tr>

1404

</table>

1405

1406

1407

1408

1409

1410

1411

1412

1413

1414

1415

1416

1417

1418

1419

1420

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

1421

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

1422

1423

</tr></table>

1424

1425

<h2 class="section">2.1 Getting Started with Levelpacks</h2>

1426

1427

One of the outstanding features of Enigma is its extensibility by new levels.

1428

And the community of users usually provides us several new great levels every week.

1429

1430

Adding a new level that you receive as an XML file is very simple. Locate the

1431

subdirectory ‘<samp>levels/auto</samp>’ on your ‘<samp>user path</samp>’ (see section <a href="#Locating-Resources">Locating Resources</a>).

1432

Just copy the level file to this folder and restart Enigma. The new level will be

1433

part of the ‘<samp>Auto</samp>’ levelpack, and you can play it like any other level.

1434

1435

Please note that Enigma displays erroneous or incompatible levels with an error icon in the level

1436

menu. Of course an attempt to run such a level will result in an error message. Look at the level

1437

metadata with the levelinspector

1438

(see section <a href="#Level-Info">Level Info</a>) to identify the required compatibility version, and contact

1439

the author via the address in case of level code errors.

1440

1441

A second way to run new levels is to add the address of the level files to the

1442

commandline (see section <a href="#Startup-Switches">Startup Switches</a>). This way you can play levels that are stored

1443

anywhere, and you may even use url addresses of levels stored on the internet. Levels added to

1444

the commandline are accessible via the ‘<samp>Startup Levels</samp>’

1445

levelpack.

1446

1447

If you want to run an old-fashioned Lua level that someone wrote for Enigma 0.92 or earlier,

1448

you may try to start it via the commandline. These old levels miss necessary metadata for auto

1449

detection. However, commandline-supplied levels are treated as temporary levels available just

1450

for a single run of Enigma; reasonable defaults substitute the missing data. The level will

1451

probably run, but scoring and copy, paste and linking of such levels is not possible.

1452

1453

Besides single new levels, the community may provide you with complete levelpacks, too. These

1454

levelpacks may occur as directories with levels, zip archives or single XML files. You can install

1455

all of them simply by copying the files, but we have to distinguish the three formats.

1456

1457

You must copy levelpacks distributed as directories, with level files and an index file in them, to

1458

the subdirectory ‘<samp>levels</samp>’ on your ‘<samp>user path</samp>’

1459

(see section <a href="#Locating-Resources">Locating Resources</a>).

1460

1461

You must copy levelpacks distributed as zip archives to the subdirectory

1462

‘<samp>levels</samp>’ on your ‘<samp>user path</samp>’. You do not need to unpack the zip,

1463

although it is possible, as described in the section <a href="#Zip-Levelpacks">Zip Levelpacks</a>.

1464

1465

You must copy levelpacks that are distributed as a single XML index file to the subdirectory

1466

‘<samp>levels/cross</samp>’ on your ‘<samp>user path</samp>’.

1467

1468

All new levelpacks should be accessible via the levelpack

1469

menu after restarting Enigma.

1470

1471

That is all you need to know to be able to add new levels and levelpacks for

1472

testing and playing. If your main interest lies in writing your own levels, you may

1473

want to proceed directly to chapter <a href="#Level-Basics">Level Basics</a>. The rest of this chapter

1474

explains how to arrange and sort existing levels in your own levelpacks.

1475

1476

1477

1478

1479

1480

1481

1482

1483

1484

1485

1486

1487

1488

1489

1490

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

1491

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

1492

1493

</tr></table>

1494

1495

<h2 class="section">2.2 Converting 0.92 Levelpacks</h2>

1496

1497

With the changes of the levelpack index format, converting old levelpacks is necessary. Although

1498

the main work is done automatically just by starting Enigma, a few special cases remain that

1499

need manual preparation. Further on, after the autoconversion, some cleanup may be useful.

1500

1501

If you formerly maintained your levelpacks within the Enigma system levels directory, you

1502

should now copy your own levelpacks from the old Enigma version to the ‘<samp>user path</samp>’

1503

subdir ‘<samp>levels</samp>’ (see section <a href="#Locating-Resources">Locating Resources</a>). The ‘<samp>user path</samp>’ exists on all

1504

systems, and since Enigma 1.00 will never write to the system levels directory, it will perform

1505

updates and conversions only on the ‘<samp>user path</samp>’. If you

1506

registered your levelpacks on the system levels directory within the ‘<samp>index.lua</samp>’

1507

file, you need to copy these registration lines to the ‘<samp>index_user.lua</samp>’ file,

1508

which you should store on your ‘<samp>user path</samp>’.

1509

1510

If you maintained several of your own levelpacks, Enigma 0.92 allowed you to keep them

1511

in several subdirectories of the ‘<samp>levels</samp>’ directory. However, since it also allowed you to

1512

keep all level files and different indices in the ‘<samp>levels</samp>’ directory

1513

itself, you will run into trouble with the auto conversion, because Enigma 1.00 allows only one

1514

levelpack with attached level files per directory.

1515

In this case, we recommend a step-by-step conversion: in every step, provide only one old index

1516

for conversion. Enigma will convert this index to a new ‘<samp>index.xml</samp>’.

1517

Move this new index, together with all levels, to a subdirectory and convert the

1518

next levelpack.

1519

1520

A last special case occurs if you had an old index stored in ‘<samp>levels</samp>’ that

1521

referenced level files in different subdirectories of ‘<samp>levels</samp>’. Since Enigma 0.92 did not

1522

have a concept of cross-references, and Enigma 1.00 requires that you store all level files

1523

attached to a levelpack in a single subdirectory, the conversion algorithm needs to guess the

1524

correct subdirectory. It simply takes the subdirectory of the first level. If this does not fit, you

1525

may need to clean up your 0.92 levelpack prior to conversion.

1526

1527

Enigma should convert all other standard levelpacks without problems. It only performs the

1528

conversion once. As soon as the new ‘<samp>index.xml</samp>’ exists, only this

1529

index is used. Thus, after a careful check, you may remove the old ‘<samp>index.txt</samp>’.

1530

We recommend keeping a backup of the old index until you have completely switched to

1531

Enigma 1.00.

1532

1533

If you used a levelpack of your own in the zip format, you will find a subdirectory named with

1534

the base name of the zip archive in your user ‘<samp>levels</samp>’

1535

directory. Enigma stores the converted ‘<samp>index.xml</samp>’ within this directory. You

1536

may want to exchange the old ‘<samp>index.txt</samp>’ in the zip with the new index.

1537

Afterwards you can delete the subdirectory, since Enigma will load the index directly

1538

from the zip archive.

1539

1540

After converting your levelpacks, we strongly recommend that you update your own

1541

levels to the new XML format, as described in <a href="#Level-Basics">Level Basics</a>.

1542

1543

1544

1545

1546

1547

1548

1549

1550

1551

1552

1553

1554

1555

1556

1557

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

1558

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

1559

1560

</tr></table>

1561

1562

<h2 class="section">2.3 Zip Levelpacks</h2>

1563

1564

Besides the classic levelpack format of a subdirectory of ‘<samp>levels</samp>’ with

1565

an ‘<samp>index.xml</samp>’ and several level files, Enigma 1.00 provides a compatible

1566

zip archive format. This zip allows you to reduce resources and to ease distribution

1567

of levelpacks.

1568

1569

The compatibility is 100%. If you have a classic subdirectory levelpack, you

1570

can simply zip the complete subdirectory and name the zip with the name of the

1571

subdirectory, plus the standard ‘<samp>.zip</samp>’ suffix. Now you can completely remove the

1572

subdirectory; Enigma autodetects the levelpack and it is fully playable. Even cross-references

1573

into this levelpack will not be broken!

1574

1575

On the other hand, Enigma allows you to expand every zip levelpack to a subdirectory with

1576

index and level files. Again, everything runs and no cross-references are broken.

1577

1578

If you keep both, the files contained in the subdirectory precede files in the zip

1579

archive. Thus, Enigma stores updates of single files in subdirectories in parallel

1580

to existing zip archives.

1581

1582

1583

1584

1585

1586

1587

1588

1589

1590

1591

1592

1593

1594

1595

1596

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

1597

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

1598

1599

</tr></table>

1600

1601

<h2 class="section">2.4 Grouping and Sorting Levelpacks</h2>

1602

1603

As the number of levelpacks increased, it became necessary to sort and group the

1604

levelpacks in the menu. We tried to provide a useful set of default groups

1605

and default assignment of the distributed levelpacks to these groups:

1606

1607

<ul>

1608

<li>

1609

Enigma - levels that are written just for Enigma

1610

1611

</li><li>

1612

Déjà-vu - levels that you may have seen before

1613

1614

</li><li>

1615

Sokoban

1616

1617

</li><li>

1618

Facets - special sortings and views of the levels above

1619

1620

</li><li>

1621

User - personal levels and levelpacks like History, Autofolder generated by the

1622

system for the user.

1623

1624

</li><li>

1625

Development - templates and unfinished levels from the Enigma Team

1626

1627

</li><li>

1628

All Packs

1629

1630

</li></ul>

1631

1632

Still, this is just a proposal. You are free to rename the groups, add new groups and change the

1633

assignments of the levelpacks. As in other parts of Enigma, you can right or control click on the

1634

group and levelpack buttons.

1635

1636

The group configuration menu allows you to rename and reposition a group. You

1637

can choose any name that is not a duplicate, that is not enclosed in square brackets

1638

and differs from ‘<samp>Every Group</samp>’. Note that you may not be able to enter as many

1639

characters as you are used to. Sorry for this inconvenience.

1640

1641

The levelpack configuration menu allows you to assign a pack to a group. The

1642

group list contains two special entries: ‘<samp>[Every Group]</samp>’ and another name

1643

enclosed in square brackets. Selecting the first pseudogroup displays the levelpack in every

1644

group. This is the default assignment of the ‘<samp>Startup Levels</samp>’ group. The second square

1645

bracket-enclosed name is the default group of the

1646

levelpack itself. It is a hint for you and allows you to reassign a levelpack

1647

to the default group even if meanwhile you have deleted the group.

1648

1649

1650

1651

1652

1653

1654

1655

1656

1657

1658

1659

1660

1661

1662

1663

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

1664

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

1665

1666

</tr></table>

1667

1668

<h2 class="section">2.5 Creating New Levelpacks</h2>

1669

1670

To create a new levelpack, you simply select the group to which you want to add

1671

the new pack. This is most likely the ‘<samp>User</samp>’ group. Right or ctrl click on

1672

the group and simply click on the ‘<samp>New Levelpack</samp>’ button. Enigma will call the

1673

levelpack configuration menu, which allows you to enter all the important data for the creation

1674

of a levelpack.

1675

1676

First you should enter a name for the levelpack. You are limited to characters

1677

that can be used for filenames, too. You may use alphanumerical characters A-Z, a-z, 0-9 and

1678

space, underscore and hyphen. Note that you may rename the pack

1679

later for a better or more suitable display name (see section <a href="#Modifying-and-Deleting-Levelpacks">Modifying and Deleting Levelpacks</a>).

1680

1681

Later, you should decide whether you want a levelpack that can contain level

1682

sources or just a crossreference levelpack. The first one is useful for storing

1683

your own self-written levels or levels that you download from the internet.

1684

You may use the crossreference levelpacks for your favorite collections, where you simply

1685

reference existing levels of other levelpacks with your own personal sorting.

1686

You set the selected type with the ‘<samp>Level types</samp>’ button, which uses symbols

1687

for references and carbon copies.

1688

1689

The ‘<samp>Default Location</samp>’ is a number that determines the sorting location

1690

within levelpack groups, if you have not resorted the levelpack manually

1691

(see section <a href="#Grouping-and-Sorting-Levelpacks">Grouping and Sorting Levelpacks</a>). This default value is relevant only

1692

if you distribute your levelpack and want to ensure that the users will find

1693

your levelpack at a proper location. The value given after creating a new

1694

levelpack should work well in most circumstances.

1695

1696

You may declare yourself as owner or creator of the levelpack. This is just a

1697

string for identification purposes.

1698

1699

Finally, when you have completed the configuration, you can create the levelpack by

1700

clicking ‘<samp>OK</samp>’. Enigma will create the levelpack on your ‘<samp>userpath</samp>’

1701

(see section <a href="#Locating-Resources">Locating Resources</a>).

1702

1703

If you decide not to create a new levelpack, just click ‘<samp>Undo</samp>’. Enigma will not create or

1704

change anything in this case.

1705

1706

If you want to set up the new levelpack immediately, you can click directly on

1707

‘<samp>Compose Pack</samp>’. Enigma will create the levelpack, and you can use the composer to fill

1708

it with levels.

1709

1710

1711

1712

1713

1714

1715

1716

1717

1718

1719

1720

1721

1722

1723

1724

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

1725

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

1726

1727

</tr></table>

1728

1729

<h2 class="section">2.6 Modifying and Deleting Levelpacks</h2>

1730

1731

To modify a levelpack, right or ctrl click on its button in the levelpack menu.

1732

You will see the metadata for all levelpacks. However, an ‘<samp>Edit Metadata</samp>’ button will

1733

appear only for your own levelpacks, which Enigma stores on your ‘<samp>userpath</samp>’.

1734

Clicking on it allows you to edit the metadata.

1735

1736

Renaming the levelpack is possible, but Enigma will not change the filenames anymore. It will

1737

use the new name as the logical levelpack name that shows up in Enigma.

1738

1739

Other attributes that you can modify include the ‘<samp>Default Location</samp>’ and the

1740

‘<samp>Owner</samp>’.

1741

1742

Note that changing the levelpack type later is not possible. You must create a new levelpack of

1743

the proper type and copy the levels by using

1744

<a href="#Composing-Levelpacks">Composing Levelpacks</a>.

1745

1746

We do not provide a levelpack deletion function to avoid unintended loss of levelsources.

1747

Still, the deletion of a levelpack is as simple as deleting the complete levelpack

1748

directory on your ‘<samp>userpath</samp>’. For crossreference levelpacks, you simply need to

1749

delete the index XML file on the ‘<samp>levels/cross</samp>’ subdirectory of your

1750

‘<samp>userpath</samp>’.

1751

1752

1753

1754

1755

1756

1757

1758

1759

1760

1761

1762

1763

1764

1765

1766

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

1767

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

1768

1769

</tr></table>

1770

1771

<h2 class="section">2.7 Composing Levelpacks</h2>

1772

1773

You can change the levels of a levelpack by using the levelpack composer. You call it

1774

by right or ctrl clicking on the levelpack button in the levelpack menu, then

1775

clicking on the ‘<samp>Compose Pack</samp>’ button in the levelpack configuration menu.

1776

1777

The composer looks similar to the levelmenu, but it provides other functionality. Enigma lists

1778

all commands in the F1 help menu. First, if you compose your own levelpacks, you may note

1779

that the levels are bordered red. This is a warning, since you can modify these levelpacks.

1780

System levelpacks (the distributed Enigma levelpacks) will border the levels in gray, since you

1781

can use the composer only for copying levels to the clipboard.

1782

1783

The clipboard allows you to select levels in one or several levelpacks and to

1784

insert these levels as reference or as copy to your own levelpacks. First, clear

1785

the clipboard by ‘<samp>Shift delete</samp>’. Then select any levelpack you want from within the

1786

composer levels. Add them by ‘<samp>Shift click</samp>’. They will appear

1787

in the upper text lines in the composer. Return to the levelpack where you want

1788

to add the levels. Select the level behind which you want to add the levels. Use

1789

‘<samp>F8</samp>’ to insert the levels of the clipboard as references. If you edit a

1790

levelpack that can take level copies, you may use ‘<samp>F9</samp>’ to insert the levels

1791

of the clipboard as file copies.

1792

1793

As soon as you modify the levelpack, a small red triangle in the upper left corner

1794

signals the modification. Leaving the composer via the ‘<samp>OK</samp>’ button finalizes all

1795

changes. Leaving the composer via the‘<samp>Undo</samp>’ button reverts all changes.

1796

1797

Besides adding levels, you can delete levels by using the ‘<samp>delete</samp>’

1798

button. Note that Enigma will delete the level files themselves if you delete a level

1799

that is not just a reference. Be careful with all levels that have the document

1800

icon on their preview. You can revert deletions with the ‘<samp>Undo</samp>’ button.

1801

1802

You can resort all levels with the ‘<samp>alt left arrow</samp>’ and ‘<samp>alt right arrow</samp>’.

1803

The new sorting appears immediately, and you can save it by using the ‘<samp>OK</samp>’ button.

1804

1805

You can use the ‘<samp>F5</samp>’ button to update the index from the levels. This is very useful if

1806

you edit levels yourself. The levelpack will notice changes in title, revision, easy mode support

1807

etc. Enigma updates all levels of the levelpack at once.

1808

1809

By using the Auto levelpack and the composer, you can set up levelpacks of your own levels, as

1810

follows: Create a new levelpack, add the level files to the ‘<samp>auto</samp>’

1811

folder, restart Enigma, add the levels from the ‘<samp>auto</samp>’ folder to the clipboard,

1812

use the composer to insert the levelpack to your levelpack as a copy, and delete the

1813

unused level file copies from the ‘<samp>auto</samp>’ folder.

1814

1815

1816

1817

1818

1819

1820

1821

1822

1823

1824

1825

1826

1827

1828

1829

1830

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

1831

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

1832

1833

</tr></table>

1834

1835

<h1 class="chapter">3. Level Basics</h1>

1836

1837

Now that you have played some levels of Enigma, you may have noticed that Enigma is quite a

1838

dynamic game with versatile levels. Thus, it is not astonishing that it is impossible to describe

1839

such levels with a static approach of a simple object map like Sokoban. Some levels, like mazes,

1840

generate their layout and look different each time you play them. Other levels provide a dynamic

1841

behavior during the play; i.e., switches may open doors only in certain circumstances. To

1842

comply with these demands, we have integrated the powerful lightweight C extension language

1843

<a href="http://www.lua.org">Lua</a> as of version 5.1.4 into Enigma.

1844

1845

Up to Enigma 0.92, two different level formats did exist. One was a XML-like format, primarily

1846

designed for external level editor programs. Because its static object map description part was

1847

inconvenient for manual editing, many authors never used it. The second format was plain Lua

1848

code that used an interface of Enigma Lua functions to add objects and callback functions.

1849

Nearly all authors used this second format, but it had a small drawback:

1850

you could store metadata for the level (like the author name, license info, and last but not least,

1851

the level name itself) only as unformatted Lua comments, and you had

1852

to reinsert it manually into the level-package indices.

1853

1854

With the post-0.92 XMLification of Enigma, we achieved full XML support by integrating

1855

Apache Xerces, and were wondering how to get rid of the old level format drawbacks and how to

1856

add some compelling new features:

1857

1858

<ul>

1859

<li>

1860

a single format with optional parts - use only those parts you need

1861

1862

</li><li>

1863

no major changes or any limitations for Lua level authors

1864

1865

</li><li>

1866

keep all author-supplied metadata in the level

1867

1868

</li><li>

1869

enable plug & play for users - copy the level from the author and play it

1870

without manual index edition

1871

1872

</li><li>

1873

support of various encodings, such as US-ASCII, UTF-8, UTF-16, Windows-1252

1874

1875

</li><li>

1876

internationalization of levels - allow authors to add strings in their native

1877

language and supply translators with all translatable level strings and comments

1878

from the authors’ how-to-translate.

1879

1880

</li><li>

1881

add a release and dependency management for levels and libraries

1882

1883

</li><li>

1884

add level update and upgrade support for levels and libraries

1885

1886

</li><li>

1887

substitute the old XML format with a versatile editor interface

1888

1889

</li><li>

1890

keep the format open to future extensions

1891

1892

</li></ul>

1893

1894

Let us have a first view on complete simple ‘<samp>Hello World</samp>’ level in the new format:

1895

1896

<table><tr><td> </td><td><pre class="example"><?xml version="1.0" encoding="<var>UTF-8</var>" standalone="no" ?>

1897

<el:level xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://enigma-game.org/schema/level/1 level.xsd" xmlns:el="http://enigma-game.org/schema/level/1">

1898

<el:protected >

1899

<el:info el:type="<var>level</var>">

1900

<el:identity el:title="<var>Demo Simple</var>" el:id="<var>20060210ral001</var>"/>

1901

<el:version el:score="<var>1</var>" el:release="<var>1</var>" el:revision="<var>2</var>" el:status="<var>stable</var>"/>

1902

<el:author el:name="<var>Ronald Lamprecht</var>"/>

1903

1904

<el:license el:type="<var>GPL v2.0 or above</var>" el:open="<var>true</var>"/>

1905

<el:compatibility el:enigma="<var>1.10</var>"/>

1906

<el:modes el:easy="<var>false</var>" el:single="<var>true</var>" el:network="<var>false</var>"/>

1907

<el:score el:easy="<var>-</var>" el:difficult="<var>-</var>"/>

1908

</el:info>

1909

<el:luamain><![CDATA[

1910

ti["<var> </var>"] = {"fl_lawn_b"}

1911

ti["<var>#</var>"] = {"st_box"}

1912

ti["<var>o</var>"] = {"st_oxyd"}

1913

ti["<var>@</var>"] = {"#ac_marble"}

1914

1915

wo(ti, " ", {

1916

"<var>####################</var>",

1917

"<var># #</var>",

1918

"<var># o @ o #</var>",

1919

"<var># #</var>",

1920

"<var>####################</var>",

1921

})

1922

]]></el:luamain>

1923

<el:i18n/>

1924

</el:protected>

1925

</el:level>

1926

</pre></td></tr></table>

1927

1928

You may notice that the XML portion contains all the metadata that the level author is

1929

accustomed to supplying with a level. The XML part is like a formula that you can copy from a

1930

template and fill out.

1931

1932

The Lua code is embedded in the XML. The only limitation to the Lua portion is that it reserves

1933

‘<samp>]]></samp>’ for the end mark, and you would have to substitute it with

1934

‘<samp>]] ></samp>’. No further restrictions.

1935

1936

Since the example above includes all mandatory XML parts, we should achieve our aim to avoid

1937

major changes for Lua level authors.

1938

1939

You can find the example above in the ‘<samp>Exp</samp>’ levelpack grouped in

1940

‘<samp>Development</samp>’.

1941

The source code is located on the system path subdirectory

1942

‘<samp>levels/enigma_experimental</samp>’

1943

(see section <a href="#Locating-Resources">Locating Resources</a>).

1944

1945

If you make your first coding experiments on a copy of this level, either add your

1946

copy to the auto folder (see section <a href="#Getting-Started-with-Levelpacks">Getting Started with Levelpacks</a>), or use it as

1947

an argument on the command line (see section <a href="#Startup-Switches">Startup Switches</a>).

1948

1949

Of course we must look at the details of the format and explain the optional

1950

parts:

1951

1952

1953

<tr><td align="left" valign="top"><a href="#Getting-Started-with-Levels">3.1 Getting Started with Levels</a></td><td>  </td><td align="left" valign="top">

1954

</td></tr>

1955

<tr><td align="left" valign="top"><a href="#XML-Level-structure">3.2 XML Level structure</a></td><td>  </td><td align="left" valign="top">

1956

</td></tr>

1957

<tr><td align="left" valign="top"><a href="#Info-metadata">3.3 Info metadata</a></td><td>  </td><td align="left" valign="top">

1958

</td></tr>

1959

1960

</td></tr>

1961

<tr><td align="left" valign="top"><a href="#Internationalization-_0028i18n_0029">3.5 Internationalization (i18n)</a></td><td>  </td><td align="left" valign="top">

1962

</td></tr>

1963

<tr><td align="left" valign="top"><a href="#Usage">3.6 Usage</a></td><td>  </td><td align="left" valign="top">

1964

</td></tr>

1965

<tr><td align="left" valign="top"><a href="#Update-and-Upgrade">3.7 Update and Upgrade</a></td><td>  </td><td align="left" valign="top">

1966

</td></tr>

1967

<tr><td align="left" valign="top"><a href="#Library-Files">3.8 Library Files</a></td><td>  </td><td align="left" valign="top">

1968

</td></tr>

1969

<tr><td align="left" valign="top"><a href="#Multilevel-Files">3.9 Multilevel Files</a></td><td>  </td><td align="left" valign="top">

1970

</td></tr>

1971

</table>

1972

1973

1974

1975

1976

1977

1978

1979

1980

1981

1982

1983

1984

1985

1986

1987

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

1988

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

1989

1990

</tr></table>

1991

1992

<h2 class="section">3.1 Getting Started with Levels</h2>

1993

1994

Most likely you are keen on understanding the basic principles of placing

1995

objects in a level. Here is a very simple level description that can also serve

1996

as a starting-point for new landscapes. (In fact, this is the first welcome

1997

level in levelpack Enigma I, so you can try it out right away.)

1998

1999

<table><tr><td> </td><td><pre class="example"> 1 ti["<var> </var>"] = {"fl_gravel"}

2000

2 ti["<var>#</var>"] = {"st_box"}

2001

3 ti["<var>O</var>"] = {"st_oxyd"}

2002

4 if wo["IsDifficult"] then

2003

5 ti["<var>Q</var>"] = {"st_quake", name="<var>quake</var>"}

2004

6 ti["<var>T</var>"] = {"st_timer", interval=<var>10.0</var>, target="<var>quake</var>"}

2005

7 else

2006

8 ti["<var>Q</var>"] = ti[" "]

2007

9 ti["<var>T</var>"] = ti[" "]

2008

10 end

2009

11 ti["<var>@</var>"] = {"ac_marble_black", <var>0.0</var>, <var>0.5</var>}

2010

11

2011

12 wo(ti, " ", {

2012

13 "<var>####################</var>",

2013

14 "<var># #</var>",

2014

15 "<var># #</var>",

2015

16 "<var># O O #</var>",

2016

17 "<var># @ #</var>",

2017

18 "<var># #</var>",

2018

19 "<var># QT #</var>",

2019

20 "<var># #</var>",

2020

21 "<var># #</var>",

2021

22 "<var># O O #</var>",

2022

23 "<var># #</var>",

2023

24 "<var># #</var>",

2024

25 "<var>####################</var>"})

2025

</pre></td></tr></table>

2026

2027

The resulting level looks like this inside the game:

2028

2029

2030

2031

Let’s now turn to a line-by-line analysis of this program:

2032

2033

<table><tr><td> </td><td><pre class="example"> 1 ti["<var> </var>"] = {"fl_gravel"}

2034

2 ti["<var>#</var>"] = {"st_box"}

2035

3 ti["<var>O</var>"] = {"st_oxyd"}

2036

</pre></td></tr></table>

2037

2038

First we declare some keys for objects we like to use in our level map. We

2039

just add each key to our ti tiles repository and assign an object tile

2040

description that consists of the object kind name in these simple cases. The

2041

two character prefix of the kind name shows us the basic object type like floor,

2042

item, stone, actor, etc.

2043

2044

<table><tr><td> </td><td><pre class="example"> 4 if wo["IsDifficult"] then

2045

5 ti["<var>Q</var>"] = {"st_quake", name="<var>quake</var>"}

2046

6 ti["<var>T</var>"] = {"st_timer", interval=<var>10.0</var>, target="<var>quake</var>"}

2047

7 else

2048

8 ti["<var>Q</var>"] = ti[" "]

2049

9 ti["<var>T</var>"] = ti[" "]

2050

10 end

2051

</pre></td></tr></table>

2052

2053

The welcome level provides two modes, the regular difficult one and an easy one.

2054

As the regular difficult one differs just in two additional stones we add two

2055

mode specific tile declarations.

2056

2057

In the difficult mode we assign two stone definitions. Each provides the

2058

stone kind and additional attributes. The ‘<samp>st_quake</samp>’ is the stone that

2059

closes oxyd stones when being hit or toggled. We just name it, to be able to

2060

reference it later on. The second stone is a timer that should get active

2061

every 10 seconds and should send a toggle message to its target, our oxyd

2062

closing ‘<samp>st_quake</samp>’. As we did name this stone we can reference it here

2063

as target by its name.

2064

2065

<table><tr><td> </td><td><pre class="example">11 ti["<var>@</var>"] = {"ac_marble_black", <var>0.0</var>, <var>0.5</var>}

2066

</pre></td></tr></table>

2067

2068

Now we just need to declare our actor. It is a black marble that should not

2069

be placed at the left upper corner of a grid but in the mid of the left

2070

border of a tile grid. Actually we just want to center it within the level.

2071

As a one screen sized level has the extension of 20 x 13 we need the offsets

2072

given above.

2073

2074

<table><tr><td> </td><td><pre class="example">12 wo(ti, " ", {

2075

13 "<var>####################</var>",

2076

14 "<var># #</var>",

2077

15 "<var># #</var>",

2078

16 "<var># O O #</var>",

2079

17 "<var># @ #</var>",

2080

18 "<var># #</var>",

2081

19 "<var># QT #</var>",

2082

20 "<var># #</var>",

2083

21 "<var># #</var>",

2084

22 "<var># O O #</var>",

2085

23 "<var># #</var>",

2086

24 "<var># #</var>",

2087

25 "<var>####################</var>"})

2088

</pre></td></tr></table>

2089

2090

Now we can create the world simply by providing a map. We just need to call

2091

‘<samp>wo</samp>’, our world handle, provide it our tile resolver, the key of the

2092

default floor and a map of tile keys.

2093

2094

You will find all conceptional background information in chapter

2095

<a href="#Enigma-Paradigm">Enigma Paradigm</a> and more examples and syntax information in chapter

2096

<a href="#Lua-API">Lua API</a>. But first you should take the time to get aware of the XML

2097

based level metadata.

2098

2099

2100

2101

2102

2103

2104

2105

2106

2107

2108

2109

2110

2111

2112

2113

2114

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

2115

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

2116

2117

</tr></table>

2118

2119

<h2 class="section">3.2 XML Level structure</h2>

2120

2121

Let us start with a complete overview of all existing top XML element nodes. The

2122

following level skeleton contains optional elements that are beyond level basics.

2123

We include these elements for completeness:

2124

2125

<table><tr><td> </td><td><pre class="example"><?xml version="1.0" encoding="<var>UTF-8</var>" standalone="no" ?>

2126

<el:level xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://enigma-game.org/schema/level/1 level.xsd http://enigma-game.org/schema/editor editor.xsd" xmlns:el="http://enigma-game.org/schema/level/1" xmlns:ee="http://enigma-game.org/schema/editor">

2127

<el:protected>

2128

<el:info el:type="<var>level</var>">

2129

2130

</el:info>

2131

<el:elements/>

2132

<el:luamain><![CDATA[

2133

]]></el:luamain>

2134

<ee:editor/>

2135

<el:i18n/>

2136

</el:protected>

2137

<el:public>

2138

<el:i18n/>

2139

<el:upgrade/>

2140

</el:public>

2141

</el:level>

2142

</pre></td></tr></table>

2143

2144

The first line is the XML declaration. It is fixed besides the encoding

2145

specification. Enigma supports on all platforms, at least ‘<samp>US-ASCII</samp>’,

2146

‘<samp>UTF-8</samp>’, ‘<samp>UTF-16</samp>’, ‘<samp>ISO-8859-1</samp>’, ‘<samp>windows-1252</samp>’.

2147

Enter your encoding and make sure that your editor saves the level in this encoding.

2148

On some editors, you can start in ASCII mode, copy the level skeleton with a

2149

different encoding declaration, like UTF-8, save the level still in ASCII mode

2150

and reopen the file. The editor may then detect the XML declaration and switch

2151

automatically to the given encoding. Note that unless you enter

2152

international strings in the level, you do not have to bother with the encoding

2153

at all. You can choose UTF-8 in this case.

2154

2155

Some additional remarks for XML newbies: The XML markup tags are quite similar

2156

to HTML. But XML requires a corresponding

2157

end tag ‘<samp></element></samp>’ for each start tag ‘<samp><element></samp>’. For elements that have

2158

only attributes and no content,

2159

you can and should use the alternative empty element notation ‘<samp><element/></samp>’.

2160

Note that when we define an element as empty or state that no content is allowed,

2161

not a single whitespace, not even a linebreak is allowed between start and end tag. Use the

2162

empty element notation to avoid mistakes.

2163

2164

We use a pretty printing format with an indentation of 2. Each element starts on a separate line.

2165

Elements with text content have the end tag on the same line. Only elements with subelements

2166

have the end tag on a separate line with the same indentation.

2167

2168

This format is not mandatory. You can even insert linebreaks in text contents, within the marks,

2169

and even within attribute values. But note: The basic rule is that each linebreak will be

2170

substituted by a space during the XML parsing. Take this space into account to avoid mistakes,

2171

or simply live with the long lines.

2172

2173

A namespace identifier prefixes all tag names and attribute names. We

2174

use ‘<samp>el</samp>’ as an abbreviation for Enigma levels. All tag names you can

2175

manually edit use this prefix.

2176

2177

Finally, a short comment on the XML reserved characters, ‘<samp>&</samp>’ and ‘<samp><</samp>’.

2178

These two characters are reserved as tag and entity starting characters. If you

2179

need them in text contents or in attribute values, you must substitute

2180

them by the entity sequences ‘<samp>&amp;</samp>’ and ‘<samp>&lt;</samp>’. Additionally, you must enclose

2181

attribute values with either ‘<samp>"</samp>’ or ‘<samp>'</samp>’. Of course, you must substitute the

2182

enclosing character used in attribute values, too. Use ‘<samp>&quot</samp>’

2183

and ‘<samp>&apos</samp>’.

2184

2185

Elements:

2186

2187

2188

<dt> /level, required, single occurrence</dt>

2189

<dd>This is the root node. Only one instance of this node occurs per file. Like the first XML

2190

declaration line, this second line is quite fixed. There are two versions. The simple 3-attribute

2191

version, as used in the first example, and only level editor programs use the 4-attribute version

2192

as above. For manual level

2193

editing, just copy the simple version as the second line to your level file.

2194

2195

Attributes:

2196

2197

2198

<dt> xmlns:xsi, required, contents fixed</dt>

2199

<dd>Namespace definition for the schema. The contents are fixed to

2200

“http://www.w3.org/2001/XMLSchema-instance”. The attribute tag ‘<samp>xsi</samp>’ must

2201

match the prefix of the next attribute tag, and is standard.

2202

2203

</dd>

2204

<dt> xsi:schemaLocation, required, contents fixed</dt>

2205

<dd>Location of the schemas used. The contents are the fixed Enigma level

2206

namespace, followed by the schema location URL. Level editor programs will add

2207

their namespace and their schema location URL, as in the second example above.

2208

2209

</dd>

2210

<dt> xmlns:el, required, contents fixed</dt>

2211

<dd>Namespace definition for “Enigma level”. We use ‘<samp>el</samp>’ as the namespace prefix

2212

for all level element and attribute tags, as standard. The prefix used can be

2213

arbitrary, but must match this attributes tag. The contents of the attribute is

2214

fixed to the Enigma level namespace.

2215

2216

</dd>

2217

<dt> xmlns:ee, optional</dt>

2218

<dd>Only level editor programs use this last namespace definition. For

2219

example, we declared ‘<samp>ee</samp>’ as the namespace prefix for all editor element and

2220

attribute tags. The prefix you use can be arbitrary, but must match this attributes

2221

tag. The contents of the attribute are the editor’s namespace.

2222

2223

</dd>

2224

</dl>

2225

2226

</dd>

2227

<dt> /level/protected, required, single occurrence</dt>

2228

<dd>

2229

The protected node section contains all level data that derive from the author and

2230

should not be modified by anyone else.

2231

2232

</dd>

2233

<dt> /level/protected/info, required, single occurrence</dt>

2234

<dd>

2235

The info node section contains all level metadata. It is mandatory and described in

2236

detail at section <a href="#Info-metadata">Info metadata</a>.

2237

2238

</dd>

2239

<dt> /level/protected/elements, optional, single occurrence</dt>

2240

<dd>

2241

The elements node section is optional. It contains level description parts that

2242

are given in a data-driven manner. Though the driving force is the support

2243

for level editor programs, a level author may use any parts of this section he or she

2244

likes.

2245

2246

</dd>

2247

<dt> /level/protected/luamain, optional, single occurrence</dt>

2248

<dd>

2249

The luamain node section is the part to insert manually Lua level descriptions.

2250

It is described in detail at section <a href="#LUA-code">LUA code</a>.

2251

2252

</dd>

2253

<dt> /level/protected/editor, optional, single occurrence</dt>

2254

<dd>

2255

The editor node section is an open extension area for level editor programs.

2256

They can add any additional information in this section that they need.

2257

Enigma simply ignores this node section.

2258

2259

</dd>

2260

<dt> /level/protected/i18n, required, single occurrence</dt>

2261

<dd>

2262

The i18n node section contains English strings, native translations and comments

2263

supplied by the author for the translators. This node section is mandatory

2264

and described in detail at section <a href="#Internationalization-_0028i18n_0029">Internationalization (i18n)</a>.

2265

2266

</dd>

2267

<dt> /level/public, optional, single occurrence</dt>

2268

<dd>

2269

This public node section is an optional extension to the protected part. It

2270

contains information that the author has not validated and may even be added

2271

after the last author’s review.

2272

2273

</dd>

2274

<dt> /level/public/i18n, optional, single occurrence</dt>

2275

<dd>

2276

This public i18n section contains further translations supplied for the level. They

2277

may derive from the author or other sources. The translators will

2278

validate these translations, and they continue in use if the translators do not

2279

supply corrected versions. See <a href="#Internationalization-_0028i18n_0029">Internationalization (i18n)</a>.

2280

2281

</dd>

2282

<dt> /level/public/upgrade, optional, single occurrence</dt>

2283

<dd>

2284

This upgrade node is part of the <a href="#Update-and-Upgrade">Update and Upgrade</a> system.

2285

2286

</dd>

2287

</dl>

2288

2289

2290

2291

2292

2293

2294

2295

2296

2297

2298

2299

2300

2301

2302

2303

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

2304

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

2305

2306

</tr></table>

2307

2308

<h2 class="section">3.3 Info metadata</h2>

2309

2310

The Info node contains all author-supplied metadata for the level. This is the

2311

source of these data. All other parts of Enigma, such as level indices, simply contain

2312

copies that will be automatically updated to the level’s original data.

2313

2314

Let us look at all supported subnodes of info with typically used attributes:

2315

2316

<table><tr><td> </td><td><pre class="example"><el:info el:type="<var>level</var>">

2317

<el:identity el:title="<var>Demo I18N</var>" el:subtitle="<var>Translate or let it be translated</var>" el:id="<var>20060211ral002</var>"/>

2318

<el:version el:score="<var>1</var>" el:release="<var>1</var>" el:revision="<var>0</var>" el:status="<var>experimental</var>"/>

2319

<el:author el:name="<var>Ronald Lamprecht</var>" el:email="<var>ral@users.berlios.de</var>"/>

2320

2321

<el:license el:type="<var>GPL v2.0 or above</var>" el:open="<var>true</var>"/>

2322

<el:compatibility el:enigma="<var>0.92</var>"/>

2323

<el:modes el:easy="<var>false</var>" el:single="<var>true</var>" el:network="<var>false</var>"/>

2324

<el:comments/>

2325

<el:update el:url="<var>http://…</var>"/>

2326

<el:upgrade el:url="<var>http://…</var>" el:release="<var>2</var>"/>

2327

<el:score el:easy="<var>-</var>" el:difficult="<var>-</var>"/>

2328

</el:info>

2329

</pre></td></tr></table>

2330

2331

Attributes:

2332

2333

2334

<dt> type, required, values = <code>"level"</code>, <code>"library"</code>, <code>"multilevel"</code></dt>

2335

<dd>You may use the schema for single Enigma levels, libraries that contain level

2336

description parts for reuse, and descriptions for multiple levels at once.

2337

2338

‘<samp>level</samp>’ are all single level descriptions. It does not matter if you

2339

edit them manually or with a level editor program, or which description elements you

2340

use.

2341

2342

‘<samp>library</samp>’ are level description parts that may be included in levels.

2343

<a href="#Library-Files">Library Files</a> consist simply of Lua code in the luamain node. Libraries

2344

may make use of nearly all nodes besides the ‘<samp>/level/protected/info/score</samp>’

2345

and ‘<samp>/level/*/i18n</samp>’, which both must be provided, but will not be evaluated.

2346

Libraries are included in levels via the dependency node-element. See

2347

<a href="#g_t_003ccompatibility_003e"><compatibility></a>.

2348

2349

‘<samp>multilevel</samp>’ are descriptions for multiple levels at once. The main purpose

2350

is to support foreign game level formats, like the Sokoban level format, which

2351

usually describes a whole set of level maps in a single file (see section <a href="#Multilevel-Files">Multilevel Files</a>).

2352

2353

</dd>

2354

<dt> quantity, optional</dt>

2355

<dd>The number of levels contained in a multilevel file (see section <a href="#Multilevel-Files">Multilevel Files</a>).

2356

2357

</dd>

2358

</dl>

2359

2360

Contents - Elements:

2361

2362

2363

<dt> identity, required</dt>

2364

<dd>The title, subtitle and the main level identification string. See <a href="#g_t_003cidentity_003e"><identity></a>.

2365

2366

</dd>

2367

<dt> version, required</dt>

2368

<dd>All aspects of the level <a href="#g_t_003cversion_003e"><version></a>.

2369

2370

</dd>

2371

<dt> author, required</dt>

2372

<dd>All information provided about the author him- or herself. See <a href="#g_t_003cauthor_003e"><author></a>.

2373

2374

</dd>

2375

<dt> copyright, required</dt>

2376

<dd>The <a href="#g_t_003ccopyright_003e"><copyright></a> message for the level.

2377

2378

</dd>

2379

<dt> license, required</dt>

2380

<dd>Information about the <a href="#g_t_003clicense_003e"><license></a> conditions.

2381

2382

</dd>

2383

<dt> compatibility, required</dt>

2384

<dd>All information about <a href="#g_t_003ccompatibility_003e"><compatibility></a> to Enigma releases, dependencies

2385

from libraries, external data and the editor program that generated the level.

2386

2387

</dd>

2388

<dt> modes, required</dt>

2389

<dd>The <a href="#g_t_003cmodes_003e"><modes></a> that the level supports, such as difficulty, network and control.

2390

2391

</dd>

2392

<dt> comments, optional</dt>

2393

<dd>Optional comments, such as credits, dedication and code comments. See <a href="#g_t_003ccomments_003e"><comments></a>.

2394

2395

</dd>

2396

<dt> update, optional</dt>

2397

<dd><a href="#Update-and-Upgrade">Update and Upgrade</a>

2398

2399

</dd>

2400

<dt> upgrade, optional</dt>

2401

<dd><a href="#Update-and-Upgrade">Update and Upgrade</a>

2402

2403

</dd>

2404

<dt> score, required</dt>

2405

<dd>The author’s own <a href="#g_t_003cscore_003e"><score></a> of this level.

2406

2407

</dd>

2408

</dl>

2409

2410

2411

2412

</td></tr>

2413

2414

</td></tr>

2415

2416

</td></tr>

2417

2418

</td></tr>

2419

2420

</td></tr>

2421

2422

</td></tr>

2423

2424

</td></tr>

2425

2426

</td></tr>

2427

2428

</td></tr>

2429

</table>

2430

2431

2432

2433

2434

2435

2436

2437

2438

2439

2440

2441

2442

2443

2444

2445

2446

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

2447

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

2448

2449

</tr></table>

2450

2451

2452

2453

The ‘<samp>identity</samp>’ element is required, since it provides the information for human

2454

and system identification of the level.

2455

2456

<table><tr><td> </td><td><pre class="example"><el:identity el:title="<var>Demo I18N</var>" el:subtitle="<var>Translate or let it be translated</var>" el:id="<var>20060211ral002</var>"/>

2457

</pre></td></tr></table>

2458

2459

Attributes:

2460

2461

2462

<dt> title, required</dt>

2463

<dd>The English title of the level. The string can contain arbitrary characters

2464

that are displayable by Enigma’s font and XML conformant. Just in case of

2465

<a href="#Multilevel-Files">Multilevel Files</a> a trailing hash sign has a special meaning. Anyway please

2466

make sure that the title is not too long, since Enigma will use it on the level

2467

selection menu. Translations of the title can be provided in the

2468

<a href="#Internationalization-_0028i18n_0029">Internationalization (i18n)</a> sections.

2469

2470

</dd>

2471

<dt> subtitle, optional</dt>

2472

<dd>An optional English subtitle. Used for title parts that are too long for the

2473

main title, or for a short first hint. Enigma displays the subtitle on the level info

2474

page and on the start of the level. Translations of the subtitle can be provided

2475

in the <a href="#Internationalization-_0028i18n_0029">Internationalization (i18n)</a> sections.

2476

2477

</dd>

2478

<dt> id, required</dt>

2479

<dd>This is the central system identification string of the level that remains valid

2480

for all time, independent of upcoming release updates. The id string should not

2481

contain spaces, braces and wildcard characters, that means no character out

2482

of ‘<samp>*? ()[]{}</samp>’. Enigma’s main demand on the id is that it is unique among

2483

all levels created by all authors around the world and that it does not end on a

2484

closing square bracket.

2485

2486

Since you can edit levels with any text editor or different special Enigma level

2487

editors, there is no control about the uniqueness. Thus, we have to provide a

2488

simple convention to avoid any possible id clashes:

2489

2490

<var>YYYYMMDDuserNNN</var>

2491

2492

Where ‘<samp>YYYY</samp>’,‘<samp>MM</samp>’,‘<samp>DD</samp>’ is the date of the creation of the first

2493

experimental version, ‘<samp>user</samp>’ stands for a user-specific name and ‘<samp>NNN</samp>’

2494

for a random number. For example, my level called ‘<samp>Houdini</samp>’ has the id

2495

‘<samp>20060816ral719</samp>’. Of course all levels created on the same day have to

2496

differ in the random number part. The id is an Enigma level system id, and is

2497

never exposed to users.

2498

2499

For backward compatibility, legacy levels keep their former filename as the

2500

new level id, and do not fit in the name schema given above. Still, that does

2501

not harm since the only requirement is the uniqueness.

2502

2503

</dd>

2504

</dl>

2505

2506

Contents:

2507

2508

The element itself is empty - no content is allowed.

2509

2510

2511

2512

2513

2514

2515

2516

2517

2518

2519

2520

2521

2522

2523

2524

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

2525

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

2526

2527

</tr></table>

2528

2529

2530

2531

This element provides the versioning information for the system.

2532

2533

<table><tr><td> </td><td><pre class="example"><el:version el:score="<var>1</var>" el:release="<var>1</var>" el:revision="<var>0</var>" el:status="<var>experimental</var>"/>

2534

</pre></td></tr></table>

2535

2536

Attributes:

2537

2538

2539

<dt> score, required</dt>

2540

<dd>The score version is given as a positive integer number. New levels start with

2541

score version “1”. New level versions need to increase the

2542

score version number if the level modifications cause different solutions with

2543

incomparable score values. Of course, level authors should be very restrictive

2544

with such modifications.

2545

2546

During the development of a level, you should use the attribute ‘<samp>status</samp>’ to mark a

2547

level as not released. When the author changes the ‘<samp>status</samp>’ to

2548

‘<samp>released</samp>’, he has to check scoring compatibility and increase the score

2549

version if necessary.

2550

2551

This attribute is the logical equivalence to the Enigma 0.92 ‘<samp>index.txt</samp>’ attribute

2552

‘<samp>revision</samp>’.

2553

2554

</dd>

2555

<dt> release, required</dt>

2556

<dd>The technical release version is given as a positive integer number. New levels

2557

start with release version “1”. You must increase the release version number if

2558

the level modifications cause either technical incompatibilities with previous Enigma releases,

2559

or the scoring version has been increased.

2560

2561

The primary cause for technical incompatibilities should be the compensation

2562

of Enigma engine changes. Since such compensations will not run on the old Enigma

2563

version, the level versions must be distinguished by a different release number.

2564

2565

In both cases, technical and scoring incompatibilities, the level file name must

2566

be changed, too. This is necessary since different Enigma versions may be installed on some

2567

systems at the same time. They have the need for both level versions at the same time. Internet

2568

servers providing Enigma levels need to offer the different level release at the same time, too.

2569

2570

To enable people to assign different level release files to a level itself, we

2571

strongly recommend the name convention for levels

2572

<var>AuthoridentifierLevelnumber_Releasenumber.Suffix</var>, where the levelnumber is at

2573

least 2 digits; for example, ‘<samp>ral01_2.xml</samp>’

2574

2575

</dd>

2576

<dt> revision, required</dt>

2577

<dd>The revision number is a simple, ever-increasing version number. Every published

2578

version of the level should have a new revision number. The revision number is

2579

independent from the scoring and release version number.

2580

2581

If Enigma finds two levelfiles in its data search paths with identical filenames,

2582

id, score and release version, it will load the one with the higher revision number.

2583

This feature guarantees that an older level revision stored on the user’s

2584

home level directory cannot supersede a new revision of a level distributed with a new

2585

Enigma release. Online updates will check the level revision numbers, too.

2586

2587

Although the revision evaluates to a number, the attribute can take a second

2588

string format as the literal keyword ‘<samp>$Revision$</samp>’. This

2589

<a href="http://subversion.tigris.org/">Subversion</a> format allows level authors to

2590

let their Subversion repository automatically insert the level revision number. They must simply

2591

set ‘<samp>svn propset svn:keywords "Revision" level.xml</samp>’

2592

at their repository for every level file. Since the Subversion revision number is

2593

ever-increasing, it fulfills our criteria. Note that Enigma does not require that revision

2594

numbers be consecutive.

2595

2596

</dd>

2597

<dt> status, required, values = “released”, “stable”, “test”, “experimental”</dt>

2598

<dd>This attribute describes the quality of the level during development. Enigma

2599

uses the status to protect the score database from being spoiled by unplanned solution

2600

scores. It will record scores only for levels marked as ‘<samp>released</samp>’.

2601

2602

As a level author, if you start to change a released level, you should first change the

2603

status back to ‘<samp>experimental</samp>’. Then make your changes and test

2604

the level. When you are definitively sure that you did not introduce any spoilers,

2605

you can release the level again with a new revision and perhaps a new release or

2606

score version number.

2607

2608

</dd>

2609

</dl>

2610

2611

Contents:

2612

2613

The element itself is empty - no content is allowed.

2614

2615

2616

2617

2618

2619

2620

2621

2622

2623

2624

2625

2626

2627

2628

2629

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

2630

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

2631

2632

</tr></table>

2633

2634

2635

2636

The information about the author him/herself. Enigma requires the author element itself, but

2637

all attributes are optional to allow an author to be anonymous. Please remember that level

2638

administrators and translators may need to contact you as the author. So please provide a way

2639

for them to contact you.

2640

2641

The author element node may look like:

2642

2643

<table><tr><td> </td><td><pre class="example"><el:author el:name="<var>Ronald Lamprecht</var>" el:email="<var>ral@users.berlios.de</var>" el:homepage="<var>http://myhomepage.domain</var>"/>

2644

</pre></td></tr></table>

2645

2646

Attributes:

2647

2648

2649

<dt> name, optional, default = “anonymous”</dt>

2650

<dd>The author’s name as it will be displayed on the level info page and on the start

2651

of the level. The name defaults to ‘<samp>anonymous</samp>’.

2652

2653

</dd>

2654

<dt> email, optional</dt>

2655

<dd>The author’s email address or a newsgroup or forum he monitors. In general, this is a

2656

hint as to how to communicate with him or her. The value will simply be displayed as a string on

2657

the level info page.

2658

2659

</dd>

2660

<dt> homepage, optional</dt>

2661

<dd>An address for the author or where the author publishes additional Enigma levels.

2662

The value will simply be displayed as a string on the level info page.

2663

2664

</dd>

2665

</dl>

2666

2667

Contents:

2668

2669

The element itself is empty; no content is allowed.

2670

2671

2672

2673

2674

2675

2676

2677

2678

2679

2680

2681

2682

2683

2684

2685

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

2686

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

2687

2688

</tr></table>

2689

2690

2691

2692

The standardized location for the author’s copyright message:

2693

2694

</pre></td></tr></table>

2695

2696

Attributes:

2697

2698

none

2699

2700

Contents:

2701

2702

The author’s copyright notice.

2703

2704

2705

2706

2707

2708

2709

2710

2711

2712

2713

2714

2715

2716

2717

2718

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

2719

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

2720

2721

</tr></table>

2722

2723

2724

2725

Of course, every author is free to choose the license conditions for his/her levels.

2726

However, the author must state the conditions. Thus, this node element and its

2727

attributes are required:

2728

2729

<table><tr><td> </td><td><pre class="example"><el:license el:type="<var>GPL v2.0 or above</var>" el:open="<var>true</var>"/>

2730

</pre></td></tr></table>

2731

2732

Attributes:

2733

2734

2735

<dt> type, required</dt>

2736

<dd>A short license identifier of the license type, with an optional link address to

2737

the license text or the string ‘<samp>special</samp>’, if the author supplies his/her own

2738

license as the content of this element.

2739

2740

</dd>

2741

<dt> open, required</dt>

2742

<dd>A boolean statement, whether the chosen license fulfills the criteria of the

2743

<a href="http://www.opensource.org/">Open Source Initiative (OSI)</a>. Please note

2744

that a value of ‘<samp>false</samp>’ may prevent your level from being distributed

2745

with Enigma.

2746

2747

</dd>

2748

</dl>

2749

2750

Contents:

2751

2752

You may add a complete license text as the contents of this element. Please

2753

use the type attribute to identify the level.

2754

2755

2756

2757

2758

2759

2760

2761

2762

2763

2764

2765

2766

2767

2768

2769

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

2770

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

2771

2772

</tr></table>

2773

2774

2775

2776

<table><tr><td> </td><td><pre class="example"><el:compatibility el:enigma="<var>0.92</var>" el:engine="<var>enigma</var>">

2777

<el:dependency el:path="<var>lib/natmaze</var>" el:id="<var>lib/natmaze</var>" el:release="<var>1</var>" el:preload="<var>true</var>" el:url="<var>http://anywhere.xxx/mypage/natmaze.xml</var>"/>

2778

<el:externaldata el:path="<var>./extfile</var>" el:url="<var>http://anywhere.xxx/mypage/extdata.xml</var>"/>

2779

<el:editor el:name="<var>none</var>" el:version="<var></var>"/>

2780

</el:compatibility>

2781

</pre></td></tr></table>

2782

2783

Attributes:

2784

2785

2786

<dt> enigma, required</dt>

2787

<dd>The minimal Enigma release number required for compatibility.

2788

2789

</dd>

2790

<dt> engine, optional, values = “enigma”, “oxyd1”, “per.oxyd”, “oxyd.extra”, “oxyd.magnum”; default = “enigma”</dt>

2791

<dd>The required engine compatibility mode that influences the behavior of various

2792

objects. This attribute is evaluated only for levels. Libraries ignore this

2793

attribute.

2794

</dd>

2795

</dl>

2796

2797

Contents - Elements:

2798

2799

The compatibility element itself contains only subelements as content.

2800

2801

2802

<dt> dependency, optional, multiple occurrence</dt>

2803

<dd>You can use this element to specify any Enigma-Lua library this level depends on. You can

2804

specify several libraries by multiple occurrence of this element. If you configure a library to be

2805

preloaded, the engine will load it before it loads or executes any level Lua code. The load

2806

sequence of several libraries conforms strictly to the sequence of their dependencies elements.

2807

2808

Attributes:

2809

2810

<dt> path, required</dt>

2811

<dd>The resource path of the library without its suffix or any release extension.

2812

Enigma stores most libraries in the ‘<samp>lib</samp>’ subdirectory of its

2813

‘<samp>levels</samp>’ directory, in most cases the resource path will be like the one in

2814

the example above: ‘<samp>lib/ant</samp>’. This is the valid path for the library file

2815

that may be either ‘<samp>levels/lib/ant.xml</samp>’ or ‘<samp>levels/lib/ant.lua</samp>’ or

2816

‘<samp>levels/lib/ant_1.xml</samp>’.

2817

2818

However, libraries can also be totally level pack-specific. In this case, you may use

2819

a relative resource path, such as ‘<samp>./mylib</samp>’ and store the library in the level

2820

pack directory itself.

2821

2822

</dd>

2823

<dt> id, required</dt>

2824

<dd>The version independent id of the library, as specified in the library metadata.

2825

Enigma will check it on load of the library to avoid problems, and may use

2826

it with the release number to detect relocated libraries.

2827

2828

</dd>

2829

<dt> release, required</dt>

2830

<dd>Although different release versions of libraries must have different filenames, we require to

2831

specify the library version. Enigma will check it on load of the library to avoid problems, and

2832

may use it with the release number to detect relocated libraries.

2833

2834

</dd>

2835

<dt> preload, required</dt>

2836

<dd>A boolean statement that specifies whether the library should be preloaded. If

2837

the library is not preloaded, you can still load it via Lua code statements. Yet

2838

even those libraries must be declared since Enigma will checked them on conformance.

2839

You should always preload your libraries if you make use of the ‘<samp>elements</samp>’

2840

section.

2841

2842

</dd>

2843

<dt> url, optional</dt>

2844

<dd>This optional attribute allows you to specify a backup address for the library.

2845

This will be useful for using new libraries that are not yet distributed

2846

with the system.

2847

2848

For the development and test phase of new libraries themselves, a developer can hand out test

2849

levels with an empty ‘<samp>library</samp>’ resource path

2850

attribute. The test levels will load the newest library version as published

2851

at the given url.

2852

2853

</dd>

2854

</dl>

2855

2856

Contents:

2857

2858

none.

2859

2860

</dd>

2861

<dt> externaldata, optional, multiple occurrence</dt>

2862

<dd>You can use this element to specify any external text data file this level

2863

depends on. You can specify several files by multiple occurrences of this

2864

element. Files declared can be read via the Lua interface.

2865

2866

This feature should support levels that simulate foreign games like Sokoban

2867

within Enigma. Due to copyrights and license conditions, the inclusion of such

2868

data within a level or even the distribution with Enigma may not be possible.

2869

However, distributing or downloading the data in the original unmodified format

2870

may be legal.

2871

2872

Attributes:

2873

2874

<dt> path, required</dt>

2875

<dd>The resource path of the external data file without its suffix ‘<samp>.txt</samp>’. The

2876

path has to be either of the format <code>"./name"</code> for an external data file

2877

that is locally stored in the same folder as the level file, or will be saved

2878

at this position when it gets downloaded. Or the path can be of the format

2879

<code>"externaldata/name"</code> for shared external data files, that are referenced

2880

by multiple level files stored at different folders. The external data file will

2881

be locally stored or gets saved in the folder <code>"levels/externaldata"</code>. In any

2882

case the local name of the external data file will have the suffix ‘<samp>.txt</samp>’

2883

to mark it readable but not executable for the local operating system.

2884

2885

</dd>

2886

<dt> url, optional</dt>

2887

<dd>This optional attribute allows you to specify an internet download address for

2888

the external data file. On first access a missing external data file will be

2889

downloaded and a copy will be stored locally for further access.

2890

</dd>

2891

</dl>

2892

2893

Contents:

2894

2895

none.

2896

2897

</dd>

2898

<dt> editor, optional, single occurrence</dt>

2899

<dd>Special level editor programs use this element to store information about themselves.

2900

2901

Attributes:

2902

2903

2904

<dt> name, required</dt>

2905

<dd>The name of the level editor.

2906

2907

</dd>

2908

<dt> version, required</dt>

2909

<dd>A version number of the editor, given as a string.

2910

.

2911

</dd>

2912

</dl>

2913

2914

Contents:

2915

2916

none

2917

2918

</dd>

2919

</dl>

2920

2921

Contents:

2922

2923

none

2924

2925

2926

2927

2928

2929

2930

2931

2932

2933

2934

2935

2936

2937

2938

2939

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

2940

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

2941

2942

</tr></table>

2943

2944

2945

2946

The modes element allows the author to declare the supported and the default

2947

modes of his level. Enigma’s engine checks that the level is used in supported

2948

modes.

2949

2950

<table><tr><td> </td><td><pre class="example"><el:modes el:easy="<var>false</var>" el:single="<var>true</var>" el:network="<var>false</var>" el:control="<var>force</var>" el:scoreunit="<var>duration</var>" el:scoretarget="<var>time</var>"/>

2951

</pre></td></tr></table>

2952

2953

Attributes:

2954

2955

2956

<dt> easy, required, values = “true”, “false”</dt>

2957

<dd>If a level provides a second easy-difficulty mode, set this attribute to ‘<samp>true</samp>’.

2958

If only a one difficulty mode is supported, set this attribute to ‘<samp>false</samp>’.

2959

2960

</dd>

2961

<dt> single, required, values = “true”, “false”</dt>

2962

<dd>If a level provides a single player game as it is standard, set this attribute to

2963

‘<samp>true</samp>’. Set this attribute to ‘<samp>false</samp>’ only if the level is a 2-player-network game.

2964

2965

</dd>

2966

<dt> network, required, values = “true”, “false”</dt>

2967

<dd>If a level provides a 2-player-network game, set this attribute to ‘<samp>true</samp>’.

2968

If not, set this attribute to ‘<samp>false</samp>’.

2969

2970

</dd>

2971

<dt> control, optional, values = “force”, “balance”, “key”, “other”; default = “force”</dt>

2972

<dd>This attribute defines the standard control mode of the level. You can play a level by using the

2973

mouse to generate forces on the marbles, since it is the standard and was the only way up to

2974

Enigma 0.92. Or you can play a level using the mouse, or other input devices to balance the

2975

level-world with the marbles. Or you may use the keyboard with its cursor keys to move the

2976

actor like in classic Sokoban games.

2977

2978

Although the user has always the last choice to define the input method he/she

2979

currently wants to use, the author must define the standard control-mode that

2980

the scoring system uses. Enigma will save and evaluate only scores achieved in the defined

2981

control mode for high score lists.

2982

2983

</dd>

2984

<dt> scoreunit, optional, values = “duration”, “number”; default = “duration”</dt>

2985

<dd>This attribute defines the evaluation and display mode of score values. By the

2986

default ‘<samp>duration</samp>’, the score is interpreted as level solution time and displayed

2987

in a MM:SS format. The ‘<samp>number</samp>’ mode displays scores as plain

2988

numbers and lower numbers will be evaluated as better scores. This mode is appropriate

2989

for counting pushes and moves.

2990

2991

</dd>

2992

<dt> scoretarget, optional, values = “time”, “pushes”, “moves”, *; default = “time”</dt>

2993

<dd>The score target triggers the measuring of score values. ‘<samp>time</samp>’ will take the

2994

solution time, ‘<samp>pushes</samp>’ counts the pushes of stones, ‘<samp>moves</samp>’ counts the

2995

moves of the actor. Any other value will call a Lua function for score values.

2996

The target is used as a short title for the score in user interface displays.

2997

2998

</dd>

2999

</dl>

3000

3001

Contents:

3002

3003

none

3004

3005

3006

3007

3008

3009

3010

3011

3012

3013

3014

3015

3016

3017

3018

3019

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

3020

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

3021

3022

</tr></table>

3023

3024

3025

3026

The optional comments node allows the author to add a few comments and to determine how

3027

they should be processed. Please note that internationalization support will not translate

3028

comments.

3029

3030

3031

<el:credits el:showinfo="<var>true</var>" el:showstart="<var>false</var>"><var>Thanks to the author of my favorite libs</var></el:credits>

3032

<el:dedication el:showinfo="<var>true</var>" el:showstart="<var>false</var>"><var>To a honorable or a beloved person</var></el:dedication>

3033

<el:code><var>some important general notes</var></el:code>

3034

</el:comments>

3035

</pre></td></tr></table>

3036

3037

Attributes:

3038

none

3039

3040

Contents - Elements:

3041

3042

The comments element itself contains only subelements as content.

3043

3044

3045

<dt> credits, optional, single occurrence</dt>

3046

<dd>The place to honor people who helped to make your level run.

3047

3048

Attributes:

3049

3050

<dt> showinfo, optional, default = “false”</dt>

3051

<dd>A value of ‘<samp>true</samp>’ will display the message on the level info

3052

page

3053

3054

</dd>

3055

<dt> showstart, optional, default = “false”</dt>

3056

<dd>A value of ‘<samp>true</samp>’ will display the message on startup of the

3057

level. Please use this feature only in rare cases.

3058

</dd>

3059

</dl>

3060

3061

Contents:

3062

3063

The credits message itself. It may be broken into several lines. Whitespace will

3064

be collapsed before display.

3065

3066

</dd>

3067

<dt> dedication, optional, single occurrence</dt>

3068

<dd>The place to dedicate the level to a honorable or a beloved person. Please use

3069

this place instead of adding document-items within the level.

3070

3071

Attributes:

3072

3073

<dt> showinfo, optional, default = “false”</dt>

3074

<dd>A value of ‘<samp>true</samp>’ will display the message on the level info

3075

page

3076

3077

</dd>

3078

<dt> showstart, optional, default = “false”</dt>

3079

<dd>A value of ‘<samp>true</samp>’ will display the message on startup of the

3080

level. Please use this feature only in rare cases.

3081

</dd>

3082

</dl>

3083

3084

Contents:

3085

3086

The dedication message itself. It may be broken into several lines. Whitespace will

3087

be collapsed before display.

3088

3089

</dd>

3090

<dt> code, optional, single occurrence</dt>

3091

<dd>

3092

Attributes:

3093

3094

none.

3095

3096

Contents:

3097

3098

The main code comment, which may be an explanation of the <a href="#g_t_003cversion_003e"><version></a> status

3099

or a to-do list. It may be broken into several lines. This comment will not be

3100

processed.

3101

3102

</dd>

3103

</dl>

3104

3105

3106

3107

3108

3109

3110

3111

3112

3113

3114

3115

3116

3117

3118

3119

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

3120

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

3121

3122

</tr></table>

3123

3124

3125

3126

In this node, the author should provide his own scoring values as hints and

3127

a challenge for other players. All values are related to the control mode defined

3128

in <a href="#g_t_003cmodes_003e"><modes></a>.

3129

3130

<table><tr><td> </td><td><pre class="example"><el:score el:easy="<var>01:07</var>" el:difficult="<var>-</var>"/>

3131

</pre></td></tr></table>

3132

3133

Attributes:

3134

3135

3136

<dt> easy, required</dt>

3137

<dd>The solution time for the easy mode. The format is either <var>MM:SS</var>, where

3138

MM stands for the minutes, and SS for the seconds, or <var>-</var> if the author did

3139

not yet solve the level him/herself. For levels with a score unit mode ‘<samp>number</samp>’,

3140

the value would be the number of marble moves or pushes.

3141

3142

</dd>

3143

<dt> difficult, required</dt>

3144

<dd>The solution time for the difficult mode. The format is either <var>MM:SS</var>, where

3145

MM stands for the minutes, and SS for the seconds, or <var>-</var> if the author did

3146

not yet solve the level him/herself. For levels with a score unit mode ‘<samp>number</samp>’,

3147

the value would be the number of marble moves or pushes.

3148

3149

</dd>

3150

</dl>

3151

3152

Contents:

3153

3154

3155

3156

3157

3158

3159

3160

3161

3162

3163

3164

3165

3166

3167

3168

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

3169

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

3170

3171

</tr></table>

3172

3173

3174

3175

This element takes any Lua code as a single chunk with nearly no limitations:

3176

3177

<table><tr><td> </td><td><pre class="example"> <el:luamain><![CDATA[

3178

levelw = 20

3179

levelh = 13

3180

3181

create_world( levelw, levelh)

3182

draw_border("st-wood")

3183

fill_floor("fl-leavesb", 0,0,levelw,levelh)

3184

3185

oxyd( 4,4)

3186

oxyd( 14,4)

3187

3188

document(5,10,"hint1")

3189

document(10,10,"hint2")

3190

document(10,5,"Heureka!")

3191

set_actor("ac-blackball", 4, 11)

3192

]]></el:luamain>

3193

</pre></td></tr></table>

3194

3195

Attributes:

3196

3197

none

3198

3199

Contents:

3200

3201

This element takes the main Lua code as its contents.

3202

3203

All other possible libraries that are declared as dependencies, and Lua chunks

3204

supplied by XML elements are preloaded as described in <a href="#g_t_003ccompatibility_003e"><compatibility></a>.

3205

Generally there is no more need to use Lua functions like ‘<samp>Require</samp>’ to load

3206

libraries. Just in case you need to control the point of execution were the

3207

library must be loaded, you can declare the library with the attribute

3208

‘<samp>el:preload="false"</samp>’. You should use the new function @ref{enigma.LoadLib}

3209

to load the library.

3210

3211

The Lua code that is enclosed in a XML CDATA section. This limits the

3212

Lua code not to use the reserved end marker ‘<samp>]]></samp>’. Any occurrence must be

3213

substituted by ‘<samp>]] ></samp>’.

3214

3215

On the other hand, the XML format extends the Lua capabilities to the use of

3216

encodings. You may use Lua strings and comments with Umlauts, but Lua identifiers are still

3217

limited to pure US-ASCII. The benefit is that you can use Umlauts and

3218

other non-ASCII characters within it-document hints.

3219

3220

3221

3222

3223

3224

3225

3226

3227

3228

3229

3230

3231

3232

3233

3234

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

3235

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

3236

3237

</tr></table>

3238

3239

<h2 class="section">3.5 Internationalization (i18n)</h2>

3240

3241

The internationalization of levels is a driving force behind the level

3242

format changes. As you may have noticed, there are two ‘<samp>i18n</samp>’ elements, one

3243

in the author’s protected section and one in the public. Let us review how to use

3244

them for internationalization of the three documents of our ‘<samp>demo_i18n.xml</samp>’

3245

level:

3246

3247

3248

3249

<el:i18n>

3250

<el:string el:key="<var>title</var>">

3251

<el:english el:translate="<var>false</var>"/>

3252

</el:string>

3253

<el:string el:key="<var>subtitle</var>">

3254

<el:english el:translate="<var>true</var>"/>

3255

<el:translation el:lang="<var>de</var>"><var>Übersetzten oder übersetzten lassen</var></el:translation>

3256

</el:string>

3257

<el:string el:key="<var>hint1</var>">

3258

<el:english el:comment="<var>Let 'right' be ambiguous: correct and opposite of left - if not possible choose correct">Read the right document</var></el:english>

3259

<el:translation el:lang="<var>de</var>"><var>Lies das rechte Dokument</var></el:translation>

3260

</el:string>

3261

<el:string el:key="<var>hint2</var>">

3262

<el:english el:comment="<var>the correct one and not the right positioned one</var>"><var>The right one, not the right one!</var></el:english>

3263

<el:translation el:lang="<var>de</var>"><var>Das rechte, nicht das rechte</var></el:translation>

3264

</el:string>

3265

<el:string el:key="<var>Heureka!</var>">

3266

<el:english el:translate="<var>false</var>"><var>Heureka!</var></el:english>

3267

</el:string>

3268

</el:i18n>

3269

</el:protected>

3270

<el:public>

3271

<el:i18n>

3272

<el:string el:key="<var>hint1</var>">

3273

<el:translation el:lang="<var>fr</var>"><var>Lisez la document de droite</var></el:translation>

3274

</el:string>

3275

</el:i18n>

3276

</el:public>

3277

</pre></td></tr></table>

3278

3279

Two of the documents use key words to reference a string. The last one uses the

3280

English string itself as the key. There are two additional reserved keys,

3281

‘<samp>title</samp>’ and ‘<samp>subtitle</samp>’.

3282

3283

For each string we like to translate or have translated, we define a ‘<samp>string</samp>’

3284

subelement of the protected section and add a ‘<samp>english</samp>’ subelement to the

3285

‘<samp>string</samp>’ element itself. The ‘<samp>string</samp>’ element just takes a single

3286

mandatory attribute, the key of the string. The ‘<samp>english</samp>’ element has a

3287

single mandatory attribute ‘<samp>translate</samp>’ that defaults to ‘<samp>true</samp>’, stating

3288

the author’s decision whether the string should be translated. If the author

3289

does not want a string to be translated, he can and must simply add no ‘<samp>string</samp>’

3290

element for this string at all. Thus, the elements for the strings with the keys

3291

‘<samp>title</samp>’ and ‘<samp>Heureka!</samp>’ are optional and quite unusual.

3292

3293

‘<samp>title</samp>’ and ‘<samp>subtitle</samp>’ display the English text in the <a href="#g_t_003cidentity_003e"><identity></a>

3294

element. All other strings referenced by keys need to add the

3295

English text as the content of the ‘<samp>english</samp>’ element. ‘<samp>hint1</samp>’ and

3296

‘<samp>hint2</samp>’ are examples.

3297

3298

Because we chose quite ambiguous English texts, it is very likely that translators

3299

who do not play the game but just translate the text, may deliver a wrong

3300

translation. To avoid mistakes, a level author may add a ‘<samp>comment</samp>’ attribute

3301

to the ‘<samp>english</samp>’ element. The translator receives this comment with

3302

the English string as we will see later.

3303

3304

If the author is not native English-speaking, he should add his own ‘<samp>translation</samp>’

3305

subelement to the ‘<samp>string</samp>’ element. The ‘<samp>translation</samp>’ element has a

3306

single mandatory attribute ‘<samp>lang</samp>’ that takes the 2-character language

3307

abbreviation. The contents of the element is the translation itself.

3308

3309

All translations added in the protected section take precedence over any translator’s

3310

translation and will work directly after addition without waiting for a translator’s

3311

translation.

3312

3313

Last but not least, we have an ‘<samp>i18n</samp>’ element in the public section. This element

3314

takes translation suggestions. The author may add them him/herself for other

3315

languages he/she knows. They may be added by others on the way to the user,

3316

or even by the user himself.

3317

3318

Translations in this section will work immediately after addition without

3319

waiting for a translator’s translation. However, available translations, provided by translators,

3320

will precede them.

3321

3322

The format is identical to the protected section, with the exception that no

3323

‘<samp>english</samp>’ element may be provided. The ‘<samp>key</samp>’ attribute in the

3324

‘<samp>string</samp>’ element must match exactly the ‘<samp>key</samp>’ attribute in the corresponding

3325

‘<samp>string</samp>’ element in the protected section. One subtle difference exists,

3326

due to technical and practical reasons. ‘<samp>key</samp>’ attributes in the public

3327

section need to be XML identifiers; thus, you cannot provide public translations

3328

for strings that use the English phrase as the key. Choose a keyword and provide

3329

the English string in the public ‘<samp>i18n</samp>’ section to avoid these troubles.

3330

3331

The ‘<samp>string</samp>’ element in protected section and in the public section

3332

must be unique concerning the attribute ‘<samp>key</samp>’ within the section. This means

3333

you should add translations for all known languages for a string in ‘<samp>string</samp>’

3334

element in the protected and in the public section. The sequence does not matter.

3335

3336

Let us review what the translator receives for each string. Let us

3337

start with ‘<samp>hint2</samp>’ for the German translator:

3338

3339

<table><tr><td> </td><td><pre class="example"># level: "<var>Demo Internationalization</var>"

3340

# author: "<var>Ronald Lamprecht</var>" email "<var>ral@users.berlios.de</var>"

3341

# comment: "<var>the correct one and not the right positioned one</var>"

3342

# use: "<var>Das rechte, nicht das rechte</var>"

3343

#: po/level_i18n.cc:17

3344

msgid "<var>The right one, not the right one!</var>"

3345

msgstr ""

3346

</pre></td></tr></table>

3347

3348

‘<samp>msgid</samp>’ is the English string. ‘<samp>msgstr</samp>’ takes the German translation.

3349

But the translator does not need to translate since the author provided the German translation

3350

in the ‘<samp># use:</samp>’ line

3351

3352

As another example, ‘<samp>hint1</samp>’ for the French translator:

3353

<table><tr><td> </td><td><pre class="example"># level: "<var>Demo Internationalization</var>"

3354

# author: "<var>Ronald Lamprecht</var>" email "<var>ral@users.berlios.de</var>"

3355

# comment: "<var>Let 'right' be ambiguous: correct and opposite of left - if not possible choose correct</var>"

3356

# check: "<var>Lisez la document de droite</var>"

3357

#: po/level_i18n.cc:14

3358

msgid "<var>Read the right document</var>"

3359

msgstr "<var>Lisez le document de droite</var>"

3360

</pre></td></tr></table>

3361

3362

Here the author gives the public translation in the ‘<samp># check:</samp>’ line. Since it

3363

contains at least one mistake, the translator will correct it, as shown in the ‘<samp>msgstr</samp>’

3364

string.

3365

3366

3367

3368

3369

3370

3371

3372

3373

3374

3375

3376

3377

3378

3379

3380

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

3381

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

3382

3383

</tr></table>

3384

3385

<h2 class="section">3.6 Usage</h2>

3386

3387

After all the theory, let’s look at how to deal with the XML levelformat in

3388

practice. Of course, you will not assemble all XML metadata from scratch for

3389

every new level you write. You should use templates. You can start with any

3390

existing level, for example, the ‘<samp>demo_i18n.xml</samp>’ supplied with this

3391

documentation. Add your personal data to your template and store it as the basis for all new

3392

levels you write.

3393

3394

Some level authors are very familiar with the Lua file format since their favorite editor supports

3395

Lua files with syntax coloring. The XML file name and the XML elements will cause

3396

their editor to use XML syntax coloring. Nevertheless, these authors are used

3397

to supplying metadata in the header of their Lua levels as non-standardized Lua

3398

comments; we decided to support a similar Lua-compatible XML format. We call it

3399

“Lua commented XML” since it simply comments out all XML lines with the Lua comment

3400

‘<samp>--xml-- </samp>’. For example:

3401

3402

3403

--xml-- <el:level xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://enigma-game.org/schema/level/1 level.xsd" xmlns:el="http://enigma-game.org/schema/level/1">

3404

--xml-- <el:protected >

3405

--xml-- <el:info el:type="level">

3406

--xml-- <el:identity el:title="Demo Simple" el:id="20060210ral001"/>

3407

--xml-- <el:version el:score="1" el:release="1" el:revision="0" el:status="stable"/>

3408

--xml-- <el:author el:name="Ronald Lamprecht"/>

3409

3410

--xml-- <el:license el:type="GPL2" el:open="true">GPL v2.0 or above</el:license>

3411

--xml-- <el:compatibility el:enigma="0.92"/>

3412

--xml-- <el:modes el:easy="false" el:single="true" el:network="false"/>

3413

--xml-- <el:score el:easy="-" el:difficult="-"/>

3414

--xml-- </el:info>

3415

--xml-- <el:luamain><![CDATA[

3416

levelw = 20

3417

levelh = 13

3418

3419

create_world( levelw, levelh)

3420

draw_border("st-wood")

3421

fill_floor("fl-leavesb", 0,0,levelw,levelh)

3422

3423

oxyd( 4,4)

3424

oxyd( 14,4)

3425

3426

set_actor("ac-blackball", 4, 11)

3427

--xml-- ]]></el:luamain>

3428

--xml-- <el:i18n/>

3429

--xml-- </el:protected>

3430

--xml-- </el:level>

3431

</pre></td></tr></table>

3432

3433

Please note that each XML metadata line must start exactly with ‘<samp>--xml-- </samp>’,

3434

8 characters, including the space at the end! An additional limitation of the

3435

Lua-commented XML format arises from Lua’s capability of handling character

3436

encodings. You need to limit yourself to ‘<samp>UTF-8</samp>’ or, of course ‘<samp>US-ASCII</samp>’

3437

to successfully use the Lua-commented XML format. Please remember, that

3438

although the XML part is Lua-commented, it must still be evaluated and thus must be

3439

valid.

3440

3441

Every level stored in this Lua-commented XML format as a file with extension

3442

‘<samp>.lua</samp>’ can be used locally for command line use as well as in any level

3443

package that is stored on the Enigma user’s home directory. However, Lua-commented XML

3444

levels cannot be stored on Internet servers or be updated online. Thus,

3445

this format is good for level development, but you should convert the levels

3446

to the pure XML format for distribution. Please note that Enigma looks for XML levels

3447

first, and uses Lua levels only if it can’t find an XML level.

3448

3449

Another use of Lua-commented XML levels is the format backward compatibility to

3450

Enigma 0.92. If levels do not use new Enigma features, you can include

3451

your levels in Enigma 0.92 level packages in this format.

3452

3453

Since you may need to convert levels several times between the XML and the Lua format,

3454

we do provide tools for conversion: ‘<samp>xml2lua</samp>’ and ‘<samp>lua2xml</samp>’. Both are

3455

very simple Lua 5 scripts that you can execute as

3456

‘<samp>lua xml2lua demo_simple.xml > demo_simple.lua</samp>’ with a properly installed

3457

Lua 5 version. On Unix systems, you can mark the scripts as executable and

3458

simply call ‘<samp>xml2lua demo_simple.xml > demo_simple.lua</samp>’.

3459

3460

Of course you can add the conversion algorithms as simple macros for your favorite

3461

editor. Please publish any editor macros you write.

3462

3463

As you fiddle with the XML metadata, you may produce syntactical errors, of course.

3464

You can validate your level by trying to start it with Enigma. XML errors are

3465

output as Lua errors are. If the error messages are too long to read, you may

3466

want to start Enigma from the command line with the option ‘<samp>--log</samp>’ and read the

3467

messages printed to the command line or written to the file ‘<samp>stdout.txt</samp>’ on

3468

the current working directory for Windows systems.

3469

3470

Of course, you can use any external XML validation tool, too. You just need to

3471

copy the schema file ‘<samp>level.xsd</samp>’ on the same directory as the level itself.

3472

Possible validation tools are the Xerces-C sample application

3473

‘<samp>DOMPrint.exe -n -s -f -v=always level.xml</samp>’ or validating editors, such as

3474

<a href="http://www.freexmleditor.com/">Exchanger XML Lite</a>. Such editors will provide

3475

you with selections of all possible elements and attributes at each position.

3476

3477

3478

3479

3480

3481

3482

3483

3484

3485

3486

3487

3488

3489

3490

3491

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

3492

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

3493

3494

</tr></table>

3495

3496

<h2 class="section">3.7 Update and Upgrade</h2>

3497

3498

Enigma is able to load new level versions since we provide all necessary

3499

attributes in the <a href="#g_t_003cversion_003e"><version></a> element.

3500

3501

If Enigma loads a new level version, which differs just in the ‘<samp>revision</samp>’, we speak of

3502

an ‘<samp>update</samp>’. You can perform updates automatically and replace old versions with

3503

the updates, since the author guarantees them to be compatible in scoring and

3504

dependencies. The author should provide a download address for automatic updates in the

3505

protected info element:

3506

3507

<table><tr><td> </td><td><pre class="example"><el:update el:url="<var>http://myLevelServer.org/path/level_1.xml</var>"/>

3508

</pre></td></tr></table>

3509

3510

Attributes:

3511

3512

3513

<dt> url, required</dt>

3514

<dd>A long-term valid, complete address for update downloads of this level in the same score and

3515

release version.

3516

3517

</dd>

3518

</dl>

3519

3520

If the author of a level introduces incompatibilities into the level, he increases the release

3521

version of the level and stores it with a new filename. We call the download of such a new level

3522

version an ‘<samp>upgrade</samp>’.

3523

3524

To publish the availability of an upgrade release, the author should update the previous release

3525

with a final revision that simply adds an upgrade element that announces the new release:

3526

3527

<table><tr><td> </td><td><pre class="example"><el:upgrade el:url="<var>http://myLevelServer.org/path/level_2.xml</var>" el:release="<var>2</var>"/>

3528

</pre></td></tr></table>

3529

3530

Attributes:

3531

3532

3533

<dt> url, required</dt>

3534

<dd>A long-term valid, complete address for upgrade downloads of this level. A path

3535

to the new file.

3536

3537

</dd>

3538

<dt> release, required</dt>

3539

<dd>The release version of the upgrade.

3540

3541

</dd>

3542

</dl>

3543

3544

Since the author cannot update all distributed levels himself to announce the availability of the

3545

new release, we added another upgrade element in the public section. Level administrators can

3546

use this element for the same purpose, with the same syntax, without modifying the author’s

3547

protected section.

3548

3549

3550

3551

3552

3553

3554

3555

3556

3557

3558

3559

3560

3561

3562

3563

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

3564

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

3565

3566

</tr></table>

3567

3568

<h2 class="section">3.8 Library Files</h2>

3569

3570

Libraries are collections of Lua functions for reuse in many levels. To use a library, you must

3571

declare it as a dependency, as described in <a href="#g_t_003ccompatibility_003e"><compatibility></a>. Preloading the library is all

3572

you have to do to use the library. Otherwise, you can use the function @ref{enigma.LoadLib} to

3573

load the library at a certain point of execution.

3574

3575

Enigma provides several very useful <a href="#Libraries">Libraries</a>. You will find them on the system

3576

path in the subdirectory ‘<samp>levels/lib</samp>’. Most of them are documented in-line.

3577

You will find a separate documentation file

3578

‘<samp>doc/ant_lua.txt</samp>’ for ‘<samp>ant</samp>’.

3579

3580

In this section, we will concentrate on the aspects of writing and maintaining

3581

libraries:

3582

3583

3584

<tr><td align="left" valign="top"><a href="#Writing-a-Library">3.8.1 Writing a Library</a></td><td>  </td><td align="left" valign="top">

3585

</td></tr>

3586

<tr><td align="left" valign="top"><a href="#Maintaining-a-Library">3.8.2 Maintaining a Library</a></td><td>  </td><td align="left" valign="top">

3587

</td></tr>

3588

</table>

3589

3590

3591

3592

3593

3594

3595

3596

3597

3598

3599

3600

3601

3602

3603

3604

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

3605

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

3606

3607

</tr></table>

3608

3609

<h3 class="subsection">3.8.1 Writing a Library</h3>

3610

3611

Library files are nearly identical to level files. The main difference is the

3612

attribute ‘<samp>el:type</samp>’ in the ‘<samp>info</samp>’ element, which you should set to

3613

‘<samp>library</samp>’. You must provide all other elements and attributes as you

3614

must for levels. Of course no scoring related attributes will ever be

3615

evaluated and you should set them to default.

3616

3617

Libraries may depend on others, so you must provide an id and a release number.

3618

Several releases of a library can coexist and you can update and upgrade them

3619

if you provide the necessary information. Of course, libraries may contain document

3620

strings that can be localized if you provide the ‘<samp>i18n</samp>’ elements.

3621

3622

The ‘<samp>el:luamain</samp>’ element takes the complete Lua code as it does for levels.

3623

Let’s look at the essential XML parts of a library:

3624

3625

<table><tr><td> </td><td><pre class="example"><?xml version="1.0" encoding="<var>UTF-8</var>" standalone="no" ?>

3626

<el:level xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://enigma-game.org/schema/level/1 level.xsd" xmlns:el="http://enigma-game.org/schema/level/1">

3627

<el:protected >

3628

<el:info el:type="<var>library</var>">

3629

<el:identity el:title="" el:id="<var>lib/ant</var>"/>

3630

<el:version el:score="<var>1</var>" el:release="<var>1</var>" el:revision="<var>0</var>" el:status="<var>released</var>"/>

3631

<el:author el:name="<var>Petr Machata</var>"/>

3632

3633

<el:license el:type="<var>GPL v2.0 or above</var>" el:open="<var>true</var>"/>

3634

<el:compatibility el:enigma="<var>0.92</var>">

3635

<el:dependency el:path="<var>lib/natmaze</var>" el:id="<var>lib/natmaze</var>" el:release="<var>1</var>" el:preload="<var>false</var>">

3636

</el:compatibility>

3637

<el:modes el:easy="<var>false</var>" el:single="<var>false</var>" el:network="<var>false</var>"/>

3638

<el:score el:easy="<var>-</var>" el:difficult="<var>-</var>"/>

3639

</el:info>

3640

<el:luamain><![CDATA[

3641

…

3642

]]></el:luamain>

3643

<el:i18n/>

3644

</el:protected>

3645

</el:level>

3646

</pre></td></tr></table>

3647

3648

3649

3650

3651

3652

3653

3654

3655

3656

3657

3658

3659

3660

3661

3662

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

3663

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

3664

3665

</tr></table>

3666

3667

<h3 class="subsection">3.8.2 Maintaining a Library</h3>

3668

3669

Libraries may exist in different releases and revisions. Library versions that differ simply in the

3670

revision, denote compatible versions. Library versions that introduce incompatibilities must

3671

differ in the release number. However, since existing levels may depend on the legacy behavior

3672

of the older release, you must maintain both library release versions and distribute them with

3673

Enigma at the same time.

3674

3675

To coexist, these different library releases must follow a strict naming scheme. Every library has

3676

a base name. In the example above it is ‘<samp>lib/ant</samp>’.

3677

The filename of a given release is the basename with the addition of an underscore and the

3678

release number plus the suffix ‘<samp>xml</samp>’. Thus, you must store release ‘<samp>lib/ant</samp>’ as

3679

‘<samp>lib/ant_2.xml</samp>’.

3680

3681

If you look at the lib directory, you may wonder that Enigma stores most library files without

3682

release number addition to the basename. This is due to 0.92 Lua level format compatibility

3683

support. You can store one, and of course only one, release of each library without release

3684

number addition to the basename. Enigma will load this version from pure Lua levels that do

3685

not provide any information of the required library release.

3686

3687

If a library file with a complete filename is not present, the default library file without release

3688

number addition will be loaded for XML load requests, too. Yet the future belongs to the new

3689

naming scheme, and every new library should follow it from the beginning.

3690

3691

3692

3693

3694

3695

3696

3697

3698

3699

3700

3701

3702

3703

3704

3705

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

3706

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

3707

3708

</tr></table>

3709

3710

<h2 class="section">3.9 Multilevel Files</h2>

3711

3712

Another concept of code reusage besides <a href="#Library-Files">Library Files</a> are multilevel files.

3713

The code contained in a single file generates several levels, called sublevels,

3714

that appear as autonomous levels in a levelpack. Of course this concept is much

3715

less flexible than the library concept as other level files can not reuse the

3716

code. But you can write a multilevel if you wrote a lot of specific code for a

3717

complex level that provides more than just two variants, which would be

3718

otherwise presented as ‘<samp>difficult</samp>’ and ‘<samp>easy</samp>’ <a href="#g_t_003cmodes_003e"><modes></a>.

3719

3720

But the main reason for multilevel files is the support of foreign game level

3721

formats like Sokoban, which describe a whole set of levels in a single file.

3722

Enigma imports these original files with just a few lines of code. It would be

3723

inefficient, even though being possible, to write an Enigma level stub for

3724

every level imported from a single foreign file.

3725

3726

But multilevel files have some restrictions. They use a single set of XML

3727

level metadata. Thus these metadata must fit to all levels. The

3728

<a href="#g_t_003cversion_003e"><version></a> will be identical as it reflects either the code version of the

3729

native level or the version of the imported foreign file. But the other data

3730

like <a href="#g_t_003cauthor_003e"><author></a>, <a href="#g_t_003ccompatibility_003e"><compatibility></a> and <a href="#g_t_003cmodes_003e"><modes></a> have to match, too.

3731

If they do not, you can not use a multilevel file.

3732

3733

Just the values for ‘<samp>title</samp>’ and ‘<samp>id</samp>’ will and have to differ for all

3734

levels described by a single multilevel file. There exists special support for

3735

multilevels to handle these attributes.

3736

3737

Let us look at all attributes and features of multilevels that differ from

3738

standard level files.

3739

3740

First you have to declare in the <a href="#Info-metadata">Info metadata</a> element the type as

3741

<code>"multilevel"</code> and to provide the quantity of generated levels. The

3742

sublevels will be numbered from 1 to the given quantity.

3743

3744

In the element <a href="#g_t_003cidentity_003e"><identity></a> you have to provide just one unique level id

3745

value. Enigma will automatically append the string <code>"[1]"</code> for the first

3746

sublevel, <code>"[2]"</code> for the second and so on. Thus every sublevel has an

3747

unique id.

3748

3749

Additionally you should provide a base title for the levels in this metadata

3750

<a href="#g_t_003cidentity_003e"><identity></a> element. If your title ends with a hash ‘<samp>#</samp>’ sign Enigma

3751

will autogenerate titles for the sublevels by appending the sublevel number to

3752

the given common title string.

3753

3754

For individual sublevel titles the <a href="#LUA-code">LUA code</a> has to provide the titles.

3755

The title in the <a href="#g_t_003cidentity_003e"><identity></a> element may not end on a hash sign and will

3756

only be used as a default title base in case the <a href="#LUA-code">LUA code</a> fails to

3757

provide a sublevel title. Prior execution of the Lua code the global

3758

attribute <a href="#SublevelNumber">SublevelNumber</a> gets initialized. The Lua part has either way to

3759

load the appropriate sublevel based on this number. Now it has additionally the

3760

task to set the second special multilevel global attribute <a href="#SublevelTitle">SublevelTitle</a>.

3761

3762

3763

<a href="#g_t_003ccompatibility_003e"><compatibility></a> externaldata

3764

3765

3766

3767

3768

3769

3770

3771

3772

3773

3774

3775

3776

3777

3778

3779

3780

3781

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

3782

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

3783

3784

</tr></table>

3785

3786

<h1 class="chapter">4. Enigma Paradigm</h1>

3787

3788

Now that you have learned about the formal declarative XML part of a level you

3789

should be eager to understand the basic principles of the participants of an

3790

Enigma level world. In this chapter we explain all the fundamental concepts and

3791

the terms used in the following chapters that describe the level author’s view

3792

of a level.

3793

3794

Please note that we describe the features of the new API of Enigma 1.10. The

3795

API of the earlier releases does not provide all the features and differs in

3796

several aspects.

3797

3798

3799

<tr><td align="left" valign="top"><a href="#The-World_0027s-Structure">4.1 The World’s Structure</a></td><td>  </td><td align="left" valign="top">

3800

</td></tr>

3801

<tr><td align="left" valign="top"><a href="#Object-Description">4.2 Object Description</a></td><td>  </td><td align="left" valign="top">

3802

</td></tr>

3803

<tr><td align="left" valign="top"><a href="#Methods-of-Interaction">4.3 Methods of Interaction</a></td><td>  </td><td align="left" valign="top">

3804

</td></tr>

3805

<tr><td align="left" valign="top"><a href="#The-Lifecycle-of-a-Level">4.4 The Lifecycle of a Level</a></td><td>  </td><td align="left" valign="top">

3806

</td></tr>

3807

</table>

3808

3809

3810

3811

3812

3813

3814

3815

3816

3817

3818

3819

3820

3821

3822

3823

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

3824

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

3825

3826

</tr></table>

3827

3828

<h2 class="section">4.1 The World’s Structure</h2>

3829

3830

We speak of a level as the opus as a whole that describes the initial composition

3831

of a gaming world and its dynamic behaviour during the game play. Let us look

3832

at the participating objects in details.

3833

3834

3835

<tr><td align="left" valign="top"><a href="#World_0027s-Shape-and-Coordinates">4.1.1 World’s Shape and Coordinates</a></td><td>  </td><td align="left" valign="top"> Grid Positions and Tiles

3836

</td></tr>

3837

<tr><td align="left" valign="top"><a href="#Object-Layers">4.1.2 Object Layers</a></td><td>  </td><td align="left" valign="top"> Floors, Items, Stones, Actors and Others

3838

</td></tr>

3839

<tr><td align="left" valign="top"><a href="#World-as-an-Object">4.1.3 World as an Object</a></td><td>  </td><td align="left" valign="top"> Global attributes and handle

3840

</td></tr>

3841

<tr><td align="left" valign="top"><a href="#Unpositioned-Objects">4.1.4 Unpositioned Objects</a></td><td>  </td><td align="left" valign="top"> Other objects like rubbers and gadgets

3842

</td></tr>

3843

<tr><td align="left" valign="top"><a href="#Player-and-Inventory">4.1.5 Player and Inventory</a></td><td>  </td><td align="left" valign="top"> Yin and Yang

3844

</td></tr>

3845

<tr><td align="left" valign="top"><a href="#Owned-Objects">4.1.6 Owned Objects</a></td><td>  </td><td align="left" valign="top"> Objects temporary owned by others

3846

</td></tr>

3847

</table>

3848

3849

3850

3851

3852

3853

3854

3855

3856

3857

3858

3859

3860

3861

3862

3863

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

3864

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

3865

3866

</tr></table>

3867

3868

<h3 class="subsection">4.1.1 World’s Shape and Coordinates</h3>

3869

3870

Having played a few levels you will have noticed that every screen shows

3871

quadratic tiles, 20 ones in the horizontal and 13 ones in the vertical direction.

3872

Even if it is difficult for a player to map together all rooms and screens of a

3873

large level, every level world has the shape of a rectangle in whole.

3874

Nevertheless some parts may never be visible to the player due to walls of

3875

stones or oceans of water.

3876

3877

3878

On the creation of a world the level author has to give its size in measure of

3879

tiles. The given width and height of the world are fixed and cannot be changed

3880

later on. A common size is 20x13 for a Onescreener. But there are no limits.

3881

You can even build levels smaller than a screen. Note that for larger levels

3882

you have to take into account that one tile row or column is usually shared

3883

between two screens on scrolling. Thus a level of 2x2 screens has a size of

3884

39x25 tiles, a 3x4 screen level has 58x49 tiles,...

3885

3886

3887

Looking at the edges of all the tiles we get a grid that spans our world. We

3888

define the upper left corner of our world as the position {0, 0}. The first

3889

coordinate is the horizontal offset to the right, the second coordinate the

3890

vertical offset to the bottom. For a Onescreener level the tile in the lower

3891

right corner is located at position {19, 12}, whereas the corner itself is at

3892

the position {20, 13} (Note that this point is actually not part of the level

3893

anymore).

3894

3895

A position of an actor like the black marble needs to be given by two floating

3896

numbers as coordinates like {1.5, 2.5} for an actor positioned in the center

3897

of the tile that is one column right and two rows down of the upper left corner

3898

tile.

3899

3900

3901

But most objects like stones can only be placed on the fixed integral grid

3902

positions. Even if you try to put a stone on {1.5, 2.5} it will be put on

3903

the grid position {1, 2}. Thus we speak of a grid position if just the

3904

integral part is taken into account. You may note that a tile is positioned

3905

according to its upper left corner. Actually the upper and the left edge are

3906

part of a tile, whereas the right and lower edge belong to the neighbour tiles.

3907

3908

3909

Finally let us look more precisely on the tile itself. On one grid position you

3910

may place a floor, an item, a stone and even several actors. The combination

3911

of all objects on one grid position is called a tile. It is a common

3912

technique to declare these object combinations once in so called tile

3913

definitions. As many grid positions share the same combination of objects these

3914

tiles can be reused very efficiently.

3915

3916

3917

3918

3919

3920

3921

3922

3923

3924

3925

3926

3927

3928

3929

3930

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

3931

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

3932

3933

</tr></table>

3934

3935

<h3 class="subsection">4.1.2 Object Layers</h3>

3936

3937

3938

On every grid position you may set a floor, an item and a stone. But just one

3939

of each. If you set a second stone the first one will be replaced. Floor, item

3940

and stone have a unique physical arrangement with the floor always being below

3941

an item and a stone always being on top of the others. Thus we speak of three

3942

object layers - the floor layer, the item layer and the stone layer.

3943

3944

3945

The floor layer has a unique prerequisite. Every grid position needs to be

3946

covered by a floor. You can define a default tile which contains a

3947

default floor that gets automatically set on every grid where you set

3948

no other floor. Even if you kill a floor, that means removing a floor

3949

without setting a replacement floor, a default floor will be set for you.

3950

3951

The floors provide two elementary features to the game: friction and adhesion.

3952

The friction slows down actors and the adhesion enables you to accelerate

3953

actors with your mouse. A floor may additionally cause a directed flat force

3954

that gives the user the feeling of a slope. And last but not least a floor

3955

may burn. A whole set of attributes let you control the details of the fire

3956

behaviour.

3957

3958

The item layer is shared between items that an actor can pick up and items that

3959

are static. The first category are items like keys, banana, etc. Static items

3960

are bombs, landmines, triggers, hollows and items that will only be set by the

3961

system itself like laserbeams, fire animations, ash, etc. As only one item can

3962

be positioned of every grid position a marble can not drop an item on such a

3963

static item. This is the technical reason that you can not intercept a laser

3964

beam by dropping an item. But as an level author you are free to add any item

3965

you like to the initial grid tile.

3966

3967

The stone layer is straight forward. The level author can choose a stone out

3968

of the repository per grid. Of course most grid positions should be kept free

3969

for the actors to move around. Even if most levels have a stone wall at the

3970

border of the world that visually limits the area this is not mandatory. Without

3971

a stone wall the marbles will be bounced at the physically boundary of the world.

3972

3973

The actors live in another layer that is not grid based. The actors can be

3974

placed at any position. Actors that pass a stone will be displayed below the

3975

stone.

3976

3977

3978

3979

3980

3981

3982

3983

3984

3985

3986

3987

3988

3989

3990

3991

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

3992

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

3993

3994

</tr></table>

3995

3996

<h3 class="subsection">4.1.3 World as an Object</h3>

3997

3998

Friction, Brittleness, Modes and Co., Scrollmodes

3999

4000

4001

4002

4003

4004

4005

4006

4007

4008

4009

4010

4011

4012

4013

4014

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

4015

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

4016

4017

</tr></table>

4018

4019

<h3 class="subsection">4.1.4 Unpositioned Objects</h3>

4020

4021

You should be missing at least one object, that can neither be assigned to a

4022

single position nor to one of the above layers: rubberbands! In fact there are

4023

many <a href="#Other-Objects">Other Objects</a> besides floors, items, stones and actors that are

4024

unpositioned. Besides visible rubberbands and wires useful gadgets,

4025

that help in plug and play composition of levels, can be added to the world.

4026

4027

All these other objects are full objects concerning the following chapters. But

4028

you need to use the world’s <a href="#add">add</a> method to add them and you need to use

4029

<a href="#Object-Reference">Object Reference</a> or <a href="#Object-Naming">Object Naming</a> to access them later on, as no

4030

position driven access does exist.

4031

4032

4033

4034

4035

4036

4037

4038

4039

4040

4041

4042

4043

4044

4045

4046

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

4047

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

4048

4049

</tr></table>

4050

4051

<h3 class="subsection">4.1.5 Player and Inventory</h3>

4052

4053

Enigma is conceptionally a game for 2 players. But nevertheless it can be played

4054

by one user on a single computer by toggling the control between two virtual

4055

players. We do call these virtual player’s <code>YIN</code> and <code>YANG</code>, as the

4056

first player controls in most cases a black marble, whereas the second

4057

controls usually a white marble.

4058

4059

Each virtual player has its own inventory of up to 13 items. The leftmost

4060

item of the inventory is called ‘<samp>revealed</samp>’, as an item activation by a

4061

mouse click does activate this item and on actor hits this item may cause

4062

special actions.

4063

4064

The players inventories do exist outside of the rectangular world. Thus

4065

any item being part of a player’s inventory will report an invalid, out of world

4066

position, that evaluates on an ‘<samp>exists()</samp>’ request to ‘<samp>false</samp>’. You

4067

can add items directly to inventories by the advanced world method <a href="#add">add</a>.

4068

4069

Even though the actors are assigned to players they are quite independent

4070

objects that live in one of the <a href="#Object-Layers">Object Layers</a>. Their relationship to

4071

players is as follows:

4072

4073

Each virtual player can own and control one or several actors of any kind. That

4074

means player <code>YIN</code> is not limited to a black <a href="#ac_005fmarble">ac_marble</a>, but may as

4075

well control a white <a href="#ac_005fpearl">ac_pearl</a>, an <a href="#ac_005fhorse">ac_horse</a> or any other set of one

4076

or several arbitrary actors.

4077

4078

Ownership and control of actors are two distinct aspects. Ownership of an actor

4079

means that every item picked up by an actor ends up in the player’s inventory and

4080

items of the player’s inventory can act on all owned actors. The control of an

4081

actor by a player does just affect the movement of the actor by the users

4082

force input. An actor may be controlled by a player without parallel ownership.

4083

Another actor may be owned by a player without being controlled by it, thus

4084

being a passive actor that depends on being pushed by others. An actor may even

4085

be controlled by both players, but it can just be owned by one player or none.

4086

4087

The assignment of actors to players is solely configured by

4088

<a href="#Actor-Attributes">Actor Attributes</a>.

4089

4090

When a single user plays Enigma he starts with the control over the player

4091

<code>Yin</code>. By usage of yinyang objects he can toggle the control to the player

4092

<code>Yang</code> and back again. Items <a href="#it_005fyinyang">it_yinyang</a> are added automatically for

4093

network levels when played by a single user. They allow an arbitrary switch

4094

between the players. The stones <a href="#st_005fyinyang">st_yinyang</a> do limit the user’s ability to

4095

switch between the player control.

4096

4097

4098

4099

4100

4101

4102

4103

4104

4105

4106

4107

4108

4109

4110

4111

4112

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

4113

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

4114

4115

</tr></table>

4116

4117

<h3 class="subsection">4.1.6 Owned Objects</h3>

4118

4119

Besides objects owned by a player and being part of his inventory, objects can

4120

be temporary part of another object. The most obvious case is an item contained

4121

in an <a href="#it_005fbag">it_bag</a>. Other samples are two <a href="#st_005fshogun">st_shogun</a> stones pushed onto

4122

the same grid position or for a short fraction of time a stone swapping the

4123

position with an <a href="#st_005fswap">st_swap</a> or an <a href="#st_005fpull">st_pull</a>.

4124

4125

In any case the owned object will report the same position as the owner itself.

4126

Even in case of some items contained in a bag that is itself part of another bag

4127

all items will report the same position as the outmost bag. If this bag is part

4128

of an player’s inventory all items report an invalid position.

4129

4130

You can not directly enforce ownership by setting two objects to the same

4131

position as this standard operation will kill and replace the old object by the

4132

new one. Where possible, like in the case of an bag, you can add objects to

4133

a container object by usage of the world advanced method <a href="#add">add</a>.

4134

4135

4136

4137

4138

4139

4140

4141

4142

4143

4144

4145

4146

4147

4148

4149

4150

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

4151

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

4152

4153

</tr></table>

4154

4155

<h2 class="section">4.2 Object Description</h2>

4156

4157

Knowing where to place objects it is time to know how to select an object type,

4158

how to specify the details of the object and how to reference it later on.

4159

4160

4161

<tr><td align="left" valign="top"><a href="#Object-Kind">4.2.1 Object Kind</a></td><td>  </td><td align="left" valign="top">

4162

</td></tr>

4163

<tr><td align="left" valign="top"><a href="#Object-Reference">4.2.2 Object Reference</a></td><td>  </td><td align="left" valign="top">

4164

</td></tr>

4165

<tr><td align="left" valign="top"><a href="#Object-Naming">4.2.3 Object Naming</a></td><td>  </td><td align="left" valign="top">

4166

</td></tr>

4167

<tr><td align="left" valign="top"><a href="#Object-Attributes">4.2.4 Object Attributes</a></td><td>  </td><td align="left" valign="top">

4168

</td></tr>

4169

</table>

4170

4171

4172

4173

4174

4175

4176

4177

4178

4179

4180

4181

4182

4183

4184

4185

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

4186

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

4187

4188

</tr></table>

4189

4190

<h3 class="subsection">4.2.1 Object Kind</h3>

4191

4192

4193

Up to now we have spoken about object kinds of floor ‘<samp>fl</samp>’, item

4194

‘<samp>it</samp>’, stone ‘<samp>st</samp>’ and actor ‘<samp>ac</samp>’. All these kinds are called

4195

abstract. You can check if a given object is of such a kind, but you can

4196

not instantiate an abstract kind.

4197

4198

To create an object you need to give a specific kind name like

4199

‘<samp>st_switch</samp>’. You will find all object kinds described in the chapters

4200

starting with <a href="#Floor-Objects">Floor Objects</a>. All these kind names with at least one

4201

underscore can be instantiated.

4202

4203

Most kinds provide subkinds like ‘<samp>st_switch_black</samp>’ and

4204

‘<samp>st_switch_white</samp>’. In case of the switches you get a color independent

4205

switch if you do not append a suffix. In other cases like ‘<samp>st_chess</samp>’

4206

the super kind will result in a default ‘<samp>st_chess_black</samp>’ as no colorless

4207

chess stone exists.

4208

4209

If you request an object for its kind it will always return the most specific

4210

kind. This means that a fresh generated ‘<samp>st_chess</samp>’ returns the kind

4211

‘<samp>st_chess_black</samp>’, whereas an ‘<samp>st_switch</samp>’ reports its name

4212

unchanged.

4213

4214

Objects can change their kind by level code statements or by user actions. You

4215

may set a color on a switch or a marble may cause a color change on a chess

4216

stone by hitting it with a revealed wand. The object will report the new kind on

4217

subsequent requests.

4218

4219

A few special object kinds do exist only for setting a new object. They are

4220

usually named with a suffix ‘<samp>_new</samp>’. These objects will never report their

4221

initial kind name but change to a standard kind immediately.

4222

4223

If you are not interested in the specific subkind you can check an object for

4224

conformity to any super kind. E.g. any switch stone of whatever color will

4225

return true if checked for ‘<samp>st_switch</samp>’.

4226

4227

4228

4229

4230

4231

4232

4233

4234

4235

4236

4237

4238

4239

4240

4241

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

4242

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

4243

4244

</tr></table>

4245

4246

<h3 class="subsection">4.2.2 Object Reference</h3>

4247

4248

Having set objects to the various layers a level author sometimes has the need

4249

of referencing them later on. On callbacks the engine provides references to

4250

sender objects. But the author can request any grid object anytime by its

4251

position.

4252

4253

With an object reference, that is of a special Lua type ‘<samp>object</samp>’, you can

4254

request the objects on its current state and attributes, modify the

4255

object, send messages or perform any supported methods of the object.

4256

4257

Objects can be grouped for efficient handling of common operations on

4258

all affected objects. E.g. if you can send a message to a group of objects

4259

all objects will receive the message in turn. The sequence of several objects

4260

in a group is constant and guaranteed to be observed in processing common

4261

operations.

4262

4263

As objects can seize to exist you have to be aware that the references are

4264

volatile, too. You can check every object reference for existence. But in many

4265

cases the validity of the reference is unimportant as Enigma 1.10 is very

4266

tolerant on invalid object references access. The operations will simply be

4267

ignored and requests will return default values.

4268

4269

As a general thumb rule you should request and keep object references just

4270

for the time of a local call. As long as your level code is processed in

4271

sequence without the running world simulation giving the player a chance to

4272

kill objects by marble actions, objects should seize to exist just due to your

4273

own direct statements.

4274

4275

To gain access to an object later on a subsequent call you can address it via

4276

two methods. First you can address it via its position. But as many objects are

4277

movable the position is not constant. Therefore you can address an object by

4278

name. See section <a href="#Object-Naming">Object Naming</a>.

4279

4280

4281

4282

4283

4284

4285

4286

4287

4288

4289

4290

4291

4292

4293

4294

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

4295

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

4296

4297

</tr></table>

4298

4299

<h3 class="subsection">4.2.3 Object Naming</h3>

4300

4301

For addressing objects on a long term valid basis every object can individually

4302

be tagged by a name. Assigning a name to an object is as simple as setting

4303

the attribute ‘<samp>name</samp>’ with a unique string on this object. Of course you

4304

can request an objects name by reading the attribute ‘<samp>name</samp>’.

4305

4306

The name is a string that should be made up of characters ‘<samp>a..z</samp>’,

4307

‘<samp>A..Z</samp>’, numbers ‘<samp>0..9</samp>’ and the underscore ‘<samp>_</samp>’. Other special

4308

characters are only allowed as far as they are explained in the following text.

4309

4310

4311

It is up to you to ensure unique names. Reuse of an already assigned name

4312

will unname the prior object and assign the name to the new object. To simplify

4313

the naming of larger groups of similar objects you can add the hash sign

4314

‘<samp>#</samp>’ as the last character to a name, e.g. ‘<samp>mydoor#</samp>’. This causes Enigma

4315

to add a unique random number to the given string. Thus an auto named object

4316

will never unname another prior auto named object. But if you delete an

4317

auto named object that has been named e.g. ‘<samp>mydoor#103284</samp>’ the number and

4318

the same name may be assigned to another that is created later on.

4319

4320

All named objects are registered by the named object repository. The API

4321

provides a variable ‘<samp>no</samp>’ that allows you to retrieve any named object, e.g.

4322

‘<samp>no["mylaser_a"]</samp>’. You get an <a href="#Object-Reference">Object Reference</a> or ‘<samp>nil</samp>’, if no

4323

object is registered by the given name.

4324

4325

As you can auto name groups of objects you are allowed to use the wildcard

4326

characters ‘<samp>?</samp>’ and ‘<samp>*</samp>’. The question mark replaces a single

4327

arbitrary character, the asterisk any number of arbitrary characters. E.g.

4328

‘<samp>no["mydoor#*"]</samp>’ retrieves all auto named ‘<samp>mydoor</samp>’ objects in a single

4329

object group.

4330

4331

Many object attributes like ‘<samp>target</samp>’, ‘<samp>destination</samp>’ need object

4332

references to other objects. Besides a volatile <a href="#Object-Reference">Object Reference</a> you always

4333

can provide a name string as a long term valid object reference. If the attribute

4334

allows several objects to be given you can either give a group of object

4335

references, a table of object names or a object name with wildcards. Thus

4336

the string ‘<samp>"mydoor#*"</samp>’ is a valid target.

4337

4338

4339

Often switches are located near by their target object. As a major shortcut

4340

you can reference the nearest object out of a group by prefixing its name

4341

with an ‘<samp>@</samp>’ character.

4342

4343

<table><tr><td> </td><td><pre class="example">ti["F"] = {"st_floppy", target="@door#*"}

4344

ti["D"] = {"st_blocker", name="door#"}

4345

</pre></td></tr></table>

4346

4347

With this tile declaration you can describe arbitrary number of floppy switches

4348

and nearby blocker doors in a world map all by the same two tile key characters.

4349

Every floppy switch will target the nearest blocker door. If two targets are

4350

given within the same distance the one located in the south will win. If the

4351

targets are additionally horizontally aligned the one located in east will win.

4352

In the rare case of objects located on the same position stones will precede

4353

items, floors and actors. The chosen target or destination depends just on the

4354

location of these objects and their type, but nothing else. Thus you can rely

4355

on a stable selection mechanism. <a href="#Nearest-Object-Clustering">Nearest Object Clustering</a> may help you in

4356

case of unexpected selected equidistant targets.

4357

4358

Auto naming and nearest object features help you to reduce the number

4359

of needed tile declarations. Resolvers like <a href="#res_002eautotile">res.autotile</a> and

4360

<a href="#res_002ecomposer">res.composer</a> are another feature for reducing the need of tile declarations.

4361

4362

Another unique feature of object names is their late on access evaluation. This

4363

allows you to reference an object prior to its existence. E.g. if you want to

4364

set two vortices each declaring the other one as its destination, object names

4365

are the favorite solution:

4366

4367

<table><tr><td> </td><td><pre class="example">wo[{3,4}] = {"it_vortex", name="vortex1", destination="vortex2"}

4368

wo[{15,9}] = {"it_vortex", name="vortex2", destination="vortex1"}

4369

</pre></td></tr></table>

4370

4371

In general you will need to use object name references within any tile

4372

declarations as none of the referenced objects will yet exist at the point of

4373

tile declarations.

4374

4375

Objects do change over time. Doors do open, a chess may be recolored, a blocker

4376

stone may shrink to a blocker item. This means that the kind of the objects

4377

will change. But in many cases this means that the volatile object reference

4378

will brake, too. For the sake of the level authors the identity of the object

4379

will be transferred even if the reference gets invalid. And like the user

4380

attributes the name is part of the object identity. Thus if you name an

4381

<a href="#st_005fblocker">st_blocker</a> and it shrinks to an <a href="#it_005fblocker">it_blocker</a> you will retrieve this

4382

item if you ask the name object repository for the named object.

4383

4384

When an object like a door is completely killed, e.g. by an <a href="#it_005fseed">it_seed</a>,

4385

it can no longer be targeted by active objects like switches. A still existing

4386

reference to a no longer existing object does not cause problems on

4387

<a href="#Messages">Messages</a>. But what about the nearest object references? To avoid problems

4388

due to killed objects the standard nearest object reference with just one

4389

‘<samp>@</samp>’ as prefix are finalized on <a href="#Level-Initialization">Level Initialization</a>. This means that

4390

they get substituted by the unique name of the nearest of all existing objects

4391

at a point of time when all objects have been created, but before the user takes

4392

action and can incidentally kill a candidate.

4393

4394

But sometimes you may like a dynamic nearest object target or destination. One

4395

that is evaluated when it gets accessed. By prefixing a name with ‘<samp>@@</samp>’

4396

the reference will not get finalized on initialization but remains dynamic.

4397

4398

<table><tr><td> </td><td><pre class="example">ti["c"] = {"it_coin_s", "magic#"}

4399

ti["v"] = {"it_vortex", destination="@@magic#*"}

4400

</pre></td></tr></table>

4401

4402

Setting three magic coins and one vortex in your map will teleport the marble

4403

to the grid of that coin that is nearest to the vortex at the moment of

4404

teleportation.

4405

4406

To avoid unexpected problems with invalid object references a few critical

4407

objects are internally autonamed if the level author does not provide a name.

4408

But these unique names should never interfere with the user assigned object

4409

names.

4410

4411

4412

4413

4414

4415

4416

4417

4418

4419

4420

4421

4422

4423

4424

4425

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

4426

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

4427

4428

</tr></table>

4429

4430

<h3 class="subsection">4.2.4 Object Attributes</h3>

4431

4432

One of the key concepts for the versatility of Enigma is possibility to fine

4433

tune objects by means of attributes. The level author is not limited to a fixed

4434

set of preconfigured objects as given by the object kind.

4435

4436

An attribute is a name, a string, with an assigned value. E.g.

4437

‘<samp>obj["inverse"]=true</samp>’ sets a single object attribute to a boolean value

4438

and ‘<samp>{"it_magnet", range=6.5}</samp>’ describes a magnet item with an initial set

4439

floating point attribute.

4440

4441

The scope of values is manifold. Most Lua types and a bunch of Enigma specific

4442

types can be assigned:

4443

<ul>

4444

<li> bool

4445

</li><li> int

4446

</li><li> double

4447

</li><li> string

4448

</li><li> nil, DEFAULT

4449

</li><li> position

4450

</li><li> object

4451

</li><li> group

4452

</li><li> tokens

4453

</li></ul>

4454

4455

If we speak of a bool value we do it in the sense of Lua 5, that means with the

4456

possible values ‘<samp>true</samp>’ and ‘<samp>false</samp>’.

4457

4458

Many enumerated values like orientations and colors are covered by the integer

4459

numbers.

4460

4461

Of special interest is the value ‘<samp>nil</samp>’. Just a few attributes make direct

4462

use of the value ‘<samp>nil</samp>’, e.g. "color" on some objects. If you set an

4463

attribute to value ‘<samp>nil</samp>’ you do actually reset its value to the default

4464

value. E.g. if you set the attribute "orientation" of <a href="#st_005fboulder">st_boulder</a> to

4465

‘<samp>nil</samp>’ it will be set to its default, which is actually ‘<samp>NORTH</samp>’, an

4466

enumerated orientation value. A subsequent read of the attribute will return this

4467

value. Just those attributes that allow a nil value will ever return ‘<samp>nil</samp>’

4468

on a read access. As a direct consequence these attributes always default to

4469

‘<samp>nil</samp>’.

4470

4471

The authors of Lua did decide to prohibit the usage of ‘<samp>nil</samp>’ as a value

4472

in Lua tables. As we make heavy usage of anonymous tables as object

4473

declarations, you would not be able to set such attributes to ‘<samp>nil</samp>’. You

4474

would need to set such attributes explicitly. As a workaround we added a custom

4475

value ‘<samp>DEFAULT</samp>’ that can be used anywhere to set attributes - even within

4476

Lua tables.

4477

4478

<table><tr><td> </td><td><pre class="example">mySwitch["color"] = nil

4479

mySwitch["color"] = DEFAULT

4480

wo[{3,6}] = {"ac_marble_black", player=DEFAULT}

4481

</pre></td></tr></table>

4482

4483

Note that ‘<samp>DEFAULT</samp>’ is not equal to ‘<samp>nil</samp>’. They are different values

4484

concerning Lua. They just result both in attributes reset to their default. If

4485

you request a nil valued attribute you will always receive the Lua value

4486

‘<samp>nil</samp>’. ‘<samp>DEFAULT</samp>’ will never be returned by the engine.

4487

4488

A group is an ordered set of <a href="#Object-Reference">Object Reference</a>s. As all contained objects

4489

must exist this value is seldom used for attributes in object declarations.

4490

But it is very useful for postprocessing of objects and for usage within

4491

<a href="#Callback-Function">Callback Function</a>s.

4492

4493

The most complex attribute value type are the tokens. Their purpose is the

4494

specification of one or many objects. As Enigma provides several means to do

4495

that this value type combines and mix all possibilities. A tokens value may

4496

be a string, representing an object name, an object reference, a group or a

4497

table with any of these basic types in any sequence and number. E.g. the

4498

following right sides are all valid tokens for the attribute ‘<samp>target</samp>’:

4499

4500

<table><tr><td> </td><td><pre class="example">obj1["target"] = "mydoor"

4501

obj2["target"] = myobject

4502

obj3["target"] = grp(ojb1, obj2, obj3)

4503

obj4["target"] = {"mydoor", myobject}

4504

obj5["target"] = {grp(ojb1, obj2, obj3), "mydoor", myobject, "anotherdoor"}

4505

</pre></td></tr></table>

4506

4507

This versatility is useful to set tokens attributes independent of the given

4508

object reference types.

4509

4510

The chapter <a href="#Common-Attributes-and-Messages">Common Attributes and Messages</a> and its followers describe

4511

the existing object attributes in detail.

4512

4513

Besides these predefined attributes the level author can store own information

4514

on objects for later retrieval. Any name starting with an underscore ‘<samp>_</samp>’

4515

can be used for level specific purposes. This prefix has been chosen as the

4516

resulting names are still valid Lua names. Common usage patterns are switches

4517

or triggers with callback functions. These functions provide the sender, the

4518

switch or trigger, as an argument. If you attach the same function to number of

4519

senders you can store the necessary context information within the sender.

4520

4521

The internal engine uses object attributes as well. Such inaccessible attributes

4522

are named with a leading dollar sign ‘<samp>$</samp>’. They may appear in the documentation

4523

for C++ developers information. Level authors should ignore these attributes.

4524

4525

In some cases you may observe a different behaviour on setting an attribute

4526

within the object definition and setting the same attribute while the object

4527

is already on the grid. E.g. a door ‘<samp>{"st_door_h", state = OPEN}</samp>’ is

4528

opened from the very beginning. Whereas ‘<samp>mydoor["state"] = OPEN</samp>’ on a

4529

closed door will start opening the door. This takes a short time until the

4530

door is really open. You find more details on these as aspects in the section

4531

<a href="#The-Lifecycle-of-a-Level">The Lifecycle of a Level</a>.

4532

4533

If you ever look into the C++ code you may wonder about the implementation of

4534

attributes. They are not all directly stored in a map. Some of them are hold

4535

in object instance variables, other do not exist at all. Objects attributes

4536

are an abstract concept that unifies several internal features within a

4537

common simple API for level description code. Within the C++ engine subtle

4538

reasons like performance optimization forces a much more complex handling.

4539

4540

4541

4542

4543

4544

4545

4546

4547

4548

4549

4550

4551

4552

4553

4554

4555

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

4556

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

4557

4558

</tr></table>

4559

4560

<h2 class="section">4.3 Methods of Interaction</h2>

4561

4562

Having looked at the description of the initial object composition of a

4563

level world we still need to understand how to configure the dynamic behaviour

4564

of a level.

4565

4566

4567

<tr><td align="left" valign="top"><a href="#Messages">4.3.1 Messages</a></td><td>  </td><td align="left" valign="top"> Asking objects to do something

4568

</td></tr>

4569

<tr><td align="left" valign="top"><a href="#Target-_002d-Action">4.3.2 Target - Action</a></td><td>  </td><td align="left" valign="top"> Automatic reactions on an event

4570

</td></tr>

4571

<tr><td align="left" valign="top"><a href="#Callback-Function">4.3.3 Callback Function</a></td><td>  </td><td align="left" valign="top"> Lua hooks to react on events

4572

</td></tr>

4573

<tr><td align="left" valign="top"><a href="#Object-State">4.3.4 Object State</a></td><td>  </td><td align="left" valign="top">

4574

</td></tr>

4575

</table>

4576

4577

4578

4579

4580

4581

4582

4583

4584

4585

4586

4587

4588

4589

4590

4591

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

4592

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

4593

4594

</tr></table>

4595

4596

<h3 class="subsection">4.3.1 Messages</h3>

4597

4598

You can generate an initially open door by setting its attributes. But how

4599

can a switch stone open a door when it is hit by a marble? It simply sends

4600

a message ‘<samp>open</samp>’ to the door. Another switch may send a message

4601

‘<samp>on</samp>’ to a laser or ‘<samp>ignite</samp>’ to an <a href="#it_005fdynamite">it_dynamite</a>. On explosion

4602

the dynamite will in turn send automatically ‘<samp>ignite</samp>’ messages to the

4603

neighbour grid positions.

4604

4605

Messages are a simple universal function or from the receiver object and the

4606

Lua level authors point of view a "method". It takes two arguments - the message

4607

name, a string, and an optional value. E.g.

4608

4609

<table><tr><td> </td><td><pre class="example">mydoor:message("open")

4610

myboulder:message("orientate", NORTH)

4611

4612

mydoor:open()

4613

myboulder:orientate(NORTH)

4614

</pre></td></tr></table>

4615

4616

The last two examples are a common abbreviation of the first two ones.

4617

4618

Messages may return a value. But most messages just return ‘<samp>nil</samp>’.

4619

4620

You can send any message to any object. Not supported messages are silently

4621

ignored. This is the reason that an exploding dynamite can send ‘<samp>ignite</samp>’

4622

messages to its neighbours without knowing if the objects can be ignited at all.

4623

Further on the dynamite has not to bother with the recipients of the messages.

4624

Due to messages the sender and the receiver objects are totally decoupled

4625

concerning the code base. Thus the level author just needs one method that

4626

allows sending arbitrary messages to arbitrary objects.

4627

4628

You should not send a message during initialization of the level. You configure

4629

the switch to send an ‘<samp>open</samp>’ message to the door by <a href="#Target-_002d-Action">Target - Action</a>.

4630

Within a Lua <a href="#Callback-Function">Callback Function</a> you may send messages during runtime to

4631

any object.

4632

4633

All messages are listed and described in <a href="#Common-Messages">Common Messages</a> and the

4634

subsequent chapters.

4635

4636

4637

4638

4639

4640

4641

4642

4643

4644

4645

4646

4647

4648

4649

4650

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

4651

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

4652

4653

</tr></table>

4654

4655

<h3 class="subsection">4.3.2 Target - Action</h3>

4656

4657

4658

The "target action paradigm" is a classical object oriented method that allows

4659

you to easily plug together objects. One object is triggered by a function

4660

call or by an event like an actor hitting a stone, crossing over or applying an

4661

item. You simply plug this object to another target object and tell it to send

4662

an action message. Every time the first object is triggered it will send the

4663

message to its target.

4664

4665

You configure such a target action by setting the attributes ‘<samp>target</samp>’

4666

and ‘<samp>action</samp>’ on the first object. E.g. a for a switch stone that should

4667

open a door named ‘<samp>mydoor</samp>’ you can write:

4668

4669

<table><tr><td> </td><td><pre class="example">{st_switch, target="mydoor", action="open"}

4670

</pre></td></tr></table>

4671

4672

Objects like the switch can be triggered on and off. Each time they will

4673

perform the action. If you would like the door to open and close in turn to

4674

the switch you need another action than ‘<samp>open</samp>’. The universal message for

4675

changing targets in their alternate states is ‘<samp>toggle</samp>’.

4676

4677

<table><tr><td> </td><td><pre class="example">{st_switch, target="mydoor", action="toggle"}

4678

{st_switch, target="mydoor"}

4679

</pre></td></tr></table>

4680

4681

Now the door will toggle in sync with the switch between its open and closed

4682

state. The message <a href="#toggle">toggle</a> can be used quite independent of the target

4683

object. In fact it is the default action message. As a default you may omit

4684

the action in this case as it is demonstrated by the second example.

4685

4686

But keep in mind that toggling just changes the state of the target. If you

4687

start with a switch in off state and an open door, the door will close when

4688

the switch in turned on. They will not sync. If you configure two switches

4689

both targeting the same door, you will have no clear relationship between the

4690

switch states and the door.

4691

4692

As you remember messages can take a value. Action messages are no exception.

4693

Every object sends its actions with a value, usually a bool value. A switch

4694

sends a value ‘<samp>true</samp>’ if it just switched on, and a value ‘<samp>false</samp>’ if

4695

it just switched off. The appropriate message for the door would be the

4696

universal message ‘<samp>signal</samp>’:

4697

4698

<table><tr><td> </td><td><pre class="example">{st_switch, target="mydoor", action="signal"}

4699

</pre></td></tr></table>

4700

4701

Now the door will open when the switch is turned on and close if the switch is

4702

turned off.

4703

4704

The message <a href="#signal">signal</a> takes an integer value of ‘<samp>0</samp>’ or ‘<samp>1</samp>’.

4705

Indeed the action value does not match. But in this as in many other cases

4706

the messages and values are designed in a way that they are automatically converted to

4707

the appropriated type. This compatibility is the basis for a seamless plugging

4708

of objects.

4709

4710

In many cases authors face the task of triggering two or more objects by a

4711

single object. ‘<samp>target</samp>’ and ‘<samp>action</samp>’ are both able to take

4712

multiple values. ‘<samp>target</samp>’ is of type tokens, as described in

4713

<a href="#Object-Attributes">Object Attributes</a>, whereas ‘<samp>action</samp>’ can be a string or a table

4714

of strings.

4715

4716

<table><tr><td> </td><td><pre class="example">{st_switch, target={grp(ojb1, obj2, obj3), "mydoor", myobject, "anotherdoor"},

4717

action={"toggle", "open", "turn", "close"}}

4718

</pre></td></tr></table>

4719

4720

All objects described by a token receive the related message in the action

4721

table. If not enough messages are listed the default action ‘<samp>toggle</samp>’

4722

will be sent.

4723

4724

Usually actions are performed at once. That is very important as the sequence

4725

of actions if often essential. Consider an <a href="#st_005fbox">st_box</a> being pushed from one

4726

<a href="#it_005ftrigger">it_trigger</a> to a neighboring one, or just an <a href="#ac_005fmarble">ac_marble</a> moving from

4727

the first trigger to the neighboring one. In both cases it is important that

4728

the first trigger is released prior the second one to be pressed. If this

4729

sequence gets mixed up both triggers could be pressed by a single object for

4730

a moment what could cause major shortcuts in a level. Thus all actions are

4731

performed in the logical sequence and in a stable, repeatable sequence without

4732

any random.

4733

4734

Action may be simple or sometimes be very complex world rearrangements. But in

4735

any case you should never ever ‘<samp>kill</samp>’ the sender object. Killing the

4736

sender can cause application crashes! Be aware that even chained actions are not

4737

allowed to kill any prior sender object. Thus an <a href="#it_005ftrigger">it_trigger</a> that toggles

4738

an <a href="#st_005fswitch">st_switch</a> which in turn kills the first trigger is as critical as the

4739

trigger killing itself. We do generally discourage you to kill any object

4740

within its own action, as there is no dissolving animation and the WYSIWYG

4741

user paradigm is violated, too. But if there is urgent need for reasons of the

4742

level gaming logic you can perform the action in a secure, delayed mode. Just

4743

add the attribute <a href="#safeaction">safeaction</a> with value ‘<samp>true</samp>’ to the self killing

4744

sender object. The action will no longer be performed at once, but with a

4745

minimum delay in a manner that will never cause crashes. But be aware that

4746

even a minimum delay, which is still within the same timeslice, may disturb

4747

the sequence of actions. This can cause unexpected logical results on the other

4748

hand.

4749

4750

4751

4752

4753

4754

4755

4756

4757

4758

4759

4760

4761

4762

4763

4764

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

4765

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

4766

4767

</tr></table>

4768

4769

<h3 class="subsection">4.3.3 Callback Function</h3>

4770

4771

4772

4773

The most powerful extension to the <a href="#Target-_002d-Action">Target - Action</a> paradigm that you can

4774

think of are callback functions. Instead of a target object as receiver of an

4775

action message you can supply an own <a href="http://www.lua.org">Lua</a> function that

4776

is called whenever the action is triggered.

4777

4778

<table><tr><td> </td><td><pre class="example">{"st_switch", target="my_magic", action="callback"}

4779

{"st_switch", target="my_magic"}

4780

</pre></td></tr></table>

4781

4782

The ‘<samp>target</samp>’ is the name of the function as a string. You may set the

4783

‘<samp>action</samp>’ to the string ‘<samp>"callback"</samp>’ for purpose of clarification,

4784

but it is not necessary as you see in the second example. The engine identifies

4785

the target to be of type of a Lua function and thus the action needs to be

4786

a callback. But you should note and remember that it is up to you to ensure that

4787

all object names and callback functions names are unique.

4788

4789

Let us look at the syntax of such a callback function

4790

4791

<table><tr><td> </td><td><pre class="example">function my_magic(value, sender)

4792

if value == true then

4793

wo[sender + {1,0}] = {"it_coin_s"}

4794

end

4795

end

4796

</pre></td></tr></table>

4797

4798

The function is called with two arguments. The first one is a value. The type

4799

and contents depends on the issuing object, but in most cases it is a boolean

4800

value. You will find the value described in the objects description. The second

4801

argument is the reference of the calling object.

4802

4803

In the example we check if the <a href="#st_005fswitch">st_switch</a> did just toggle to ON. If this

4804

is given we take the switch, which is the sender, as a position and set a new

4805

<a href="#it_005fcoin">it_coin</a> to the grid east of it - a small bank automate that supplies money.

4806

4807

The <a href="#Advanced-Lua-Examples">Advanced Lua Examples</a> will show examples of real powerful callback

4808

functions with a line by line comment.

4809

4810

Further usage and aspects of callbacks in the level’s lifecycle are given in

4811

the section <a href="#Callbacks-and-Load-Balancing">Callbacks and Load Balancing</a>.

4812

4813

4814

4815

4816

4817

4818

4819

4820

4821

4822

4823

4824

4825

4826

4827

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

4828

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

4829

4830

</tr></table>

4831

4832

<h3 class="subsection">4.3.4 Object State</h3>

4833

4834

A key concept for the ability to plug together objects like switches and doors

4835

are the very simple state machines of these objects. Most objects are described

4836

by simple machines with just 2 states like ‘<samp>ON</samp>’,‘<samp>OFF</samp>’ or ‘<samp>OPEN</samp>’,

4837

‘<samp>CLOSED</samp>’. These objects can be plugged together by just few common messages.

4838

Further on these simple state machines are suited to the gamers who do not want

4839

to read manuals but want to explore the objects by playing with just a few tests.

4840

4841

Even though states are usually named by appropriate uppercase names like above,

4842

the states are integer numbers starting with ‘<samp>0</samp>’ usually related to the

4843

default state. But some objects use another mapping due to historic reasons.

4844

E.g. states that are orientation related use the state ‘<samp>3</samp>’ representing

4845

‘<samp>NORTH</samp>’ usually as the default and number the orientations clockwise down to

4846

‘<samp>0</samp>’ representing ‘<samp>WEST</samp>’.

4847

4848

In most cases it is sufficient to perform a state independent common action

4849

like <a href="#toggle">toggle</a>. Even two stated objects can be easily synchronized by the

4850

standard action <a href="#signal">signal</a>. But sometimes you may want to perform very state

4851

specific actions. Let us look how this can be done.

4852

4853

E.g. let us take an <a href="#st_005ffourswitch">st_fourswitch</a>, that has four states, and two

4854

<a href="#st_005flaser">st_laser</a> which should be switched on and off. Both lasers should emit

4855

their beams while the fourswitch is in 3 of its states. But one of them should

4856

be off just while the fourswitch is in the ‘<samp>EAST</samp>’ state and the other

4857

should be off just while the fourswitch is in the ‘<samp>WEST</samp>’ state.

4858

This can be done by usage of state dependent target and actions:

4859

4860

<table><tr><td> </td><td><pre class="example">{st_fourswitch, target_3="laser#2", action_3="on",

4861

target_2="laser#1", action_2="off",

4862

target_1="laser#1", action_1="on",

4863

target_0="laser#2", action_0="off"}

4864

</pre></td></tr></table>

4865

4866

Adding a number as suffix to ‘<samp>target_</samp>’ and ‘<samp>action_</samp>’ gives you

4867

special target and action attributes that will take precedence over the general

4868

‘<samp>target</samp>’ and ‘<samp>action</samp>’ attributes if the state value equals the suffix

4869

number. An alternative declaration would be:

4870

4871

<table><tr><td> </td><td><pre class="example">{st_fourswitch, target={"laser#1", "laser#2"},

4872

action_3={"nop", "on"},

4873

action_2={"off", "nop"},

4874

action_1={"on", "nop"},

4875

action_0={"nop", "off"}}

4876

</pre></td></tr></table>

4877

4878

Here we do address both lasers in all states. But one of them receives a

4879

<a href="#nop">nop</a> message that stands for "no operation". In fact this message will

4880

never be send. It is just a dummy message that we have need of for syntax

4881

reasons in the case above.

4882

4883

Another example are two <a href="#it_005ftrigger">it_trigger</a> that switch a laser. An object pressing

4884

the first trigger should switch the laser on, an object pressing the second

4885

trigger should switch it off. But a trigger is two stated and performs one

4886

action on being pressed and another on being released. Thus we want to block

4887

the actions on trigger release events:

4888

4889

<table><tr><td> </td><td><pre class="example">{it_trigger, name="on_trigger", target="laser#1", action_1="on", action_0="nop"}

4890

{it_trigger, name="off_trigger", target="laser#1", action_1="off", action_0="nop"}

4891

</pre></td></tr></table>

4892

4893

The blocking of ‘<samp>action_0</samp>’ is essential and can not be omitted, as

4894

otherwise the default action would be performed. This would be a ‘<samp>toggle</samp>’

4895

message that would switch the laser.

4896

4897

As this useful default mechanism can sometimes be annoying you can switch off

4898

the default message by setting the <a href="#nopaction">nopaction</a> attribute to true.

4899

4900

<table><tr><td> </td><td><pre class="example">{it_trigger, name="on_trigger", target="laser#1", action_1="on", nopaction=true}

4901

{it_trigger, name="off_trigger", target="laser#1", action_1="off", nopaction=true}

4902

</pre></td></tr></table>

4903

4904

When an objects leaves a trigger the state ‘<samp>0</samp>’ action will be performed.

4905

As neither ‘<samp>action_0</samp>’ nor ‘<samp>action</samp>’ is specified the default action

4906

will be performed, which is now ‘<samp>nop</samp>’.

4907

4908

If you ever look into the C++ code you may note that many objects do have much

4909

more complex state machines than you expect from the level authors and gamers

4910

view. This is due to running animations, timers, etc.. The C++ objects map their

4911

complex internal state set to the much simpler external state set. This is the

4912

main reason that some features that level authors request can not be provided

4913

in the Lua API.

4914

4915

4916

4917

4918

4919

4920

4921

4922

4923

4924

4925

4926

4927

4928

4929

4930

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

4931

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

4932

4933

</tr></table>

4934

4935

<h2 class="section">4.4 The Lifecycle of a Level</h2>

4936

4937

4938

Snapshot

4939

Levelloading, Initialization, Runtime Callbacks,

4940

Ending Conditions - the mystery of Oxyds and Meditation

4941

4942

<tr><td align="left" valign="top"><a href="#Library-Preloading">4.4.1 Library Preloading</a></td><td>  </td><td align="left" valign="top">

4943

</td></tr>

4944

<tr><td align="left" valign="top"><a href="#Snapshot-Principle">4.4.2 Snapshot Principle</a></td><td>  </td><td align="left" valign="top">

4945

</td></tr>

4946

<tr><td align="left" valign="top"><a href="#Level-Initialization">4.4.3 Level Initialization</a></td><td>  </td><td align="left" valign="top">

4947

</td></tr>

4948

<tr><td align="left" valign="top"><a href="#Object-Transformation">4.4.4 Object Transformation</a></td><td>  </td><td align="left" valign="top"> Identity Transfer in case of Transformations

4949

</td></tr>

4950

<tr><td align="left" valign="top"><a href="#Named-Positions">4.4.5 Named Positions</a></td><td>  </td><td align="left" valign="top"> Positions as successors of killed Floors

4951

</td></tr>

4952

<tr><td align="left" valign="top"><a href="#Callbacks-and-Load-Balancing">4.4.6 Callbacks and Load Balancing</a></td><td>  </td><td align="left" valign="top">

4953

</td></tr>

4954

<tr><td align="left" valign="top"><a href="#Level-Restart">4.4.7 Level Restart</a></td><td>  </td><td align="left" valign="top">

4955

</td></tr>

4956

<tr><td align="left" valign="top"><a href="#Ending-Conditions">4.4.8 Ending Conditions</a></td><td>  </td><td align="left" valign="top"> Meditation vs. Oxydpairs

4957

</td></tr>

4958

</table>

4959

4960

4961

4962

4963

4964

4965

4966

4967

4968

4969

4970

4971

4972

4973

4974

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

4975

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

4976

4977

</tr></table>

4978

4979

<h3 class="subsection">4.4.1 Library Preloading</h3>

4980

4981

4982

4983

4984

4985

4986

4987

4988

4989

4990

4991

4992

4993

4994

4995

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

4996

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

4997

4998

</tr></table>

4999

5000

<h3 class="subsection">4.4.2 Snapshot Principle</h3>

5001

5002

Most levels contain objects that take influence on each other. A switch might

5003

toggle a door by <a href="#Target-_002d-Action">Target - Action</a>, marbles may press a trigger, or a laser

5004

might activate a laserswitch or transform a hammer into a sword. Of course it is

5005

essential to know how to set up such objects to get the desired start

5006

configuration without the objects changing unexpected on level initialization.

5007

5008

The snapshot principle is a simple thumb rule that you can rely on in describing

5009

the level as a snapshot of object at a given point of time. Every object has just

5010

to be configured as it should be at the given time. All interactions that would

5011

take place in a running game do not take place while setting objects during

5012

initialization.

5013

5014

E.g. if a switch toggles a door and the switch should be initially on and the

5015

door should be initially open you describe the object with exactly these

5016

attributes:

5017

5018

<table><tr><td> </td><td><pre class="example">{"st_switch", target="mydoor", state=ON}

5019

{"st_door", name="mydoor", state=OPEN}

5020

</pre></td></tr></table>

5021

5022

A laser that is initially on that illuminates a laserswitch needs an initially

5023

active laserswitch. But of course no attribute exists that would allow you to

5024

set a laserswitch active. The snapshot principle includes the rule that all

5025

internal states are updated without external actions. This means that the

5026

laserswitch will show up active without causing an action on its target.

5027

5028

<table><tr><td> </td><td><pre class="example">{"st_laser", state=ON}

5029

{"st_laserswitch", target="mydoor"}

5030

</pre></td></tr></table>

5031

5032

What about objects that transform on laser light. The snapshot principle keeps

5033

the object from transforming during initialization. A hammer that is set in

5034

an initially existing laser beam will not transform to a sword. It remains as

5035

a hammer that will transform on any subsequent new laser light during the game.

5036

5037

Of course it cannot be allowed to describe impossible initial level states.

5038

Objects like dynamite do explode immediately on a laser beam hit. Thus a

5039

dynamite item in an initial laser beam is a fault that causes an exception.

5040

The snapshot principle forces you in this case to set an explosion item instead

5041

of the dynamite.

5042

5043

Some objects do process internal state transformations that cannot be configured

5044

by attributes. But some of these states may be of interest on describing a

5045

snapshot of a level. Where possible a special object subkind exists with a suffix

5046

of ‘<samp>_new</samp>’. These objects can be used in the initial level description to

5047

set objects in special initial states. E.g. <a href="#it_005fblocker">it_blocker</a> provides such a

5048

special subkind. Note that these objects will never report their initial

5049

subkind on a kind request as they come into existence as a standard object.

5050

5051

5052

5053

5054

5055

5056

5057

5058

5059

5060

5061

5062

5063

5064

5065

5066

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

5067

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

5068

5069

</tr></table>

5070

5071

<h3 class="subsection">4.4.3 Level Initialization</h3>

5072

5073

Knowing what has been preloaded and knowing exactly which objects we have to

5074

set in which state, it is time to have a look on how your level code is

5075

processed. The main issue is to guarantee that all parts referenced have been

5076

set up properly in advance.

5077

5078

Prior execution of the first line of your code the world exists just as an

5079

abstract handle, but not as grid array able to accept objects. Thus the first

5080

lines of code should set up all <a href="#Global-Attributes">Global Attributes</a> deviating from their

5081

defaults. Even though many attributes can be set or changes later on and even

5082

on runtime, there are some attributes like <a href="#ProvideExtralifes">ProvideExtralifes</a> that take

5083

only effect if being set prior world creation, or others like <a href="#MaxOxydColor">MaxOxydColor</a>

5084

that must be set prior their first usage. Our recommendation is to collect all

5085

global attribute settings at the very beginning of the level.

5086

5087

The second section of your level code should be the declaration of tiles. Being

5088

just declarations these code lines do not set objects to the world. They just

5089

depend on global attributes and may reference each other. Listing them all

5090

together in a code section makes it easy to maintain the overview and to avoid

5091

dependency conflicts.

5092

5093

If you use <a href="#Resolvers">Resolvers</a> you should put their declarations in the next code

5094

section as they may refer to tiles and global attributes and need to be set up

5095

prior the world creation.

5096

5097

The central statement of every level is the <a href="#World-Creation">World Creation</a>. It sets up

5098

the world to its size and sets initial objects according to the given tile

5099

declarations to the grid array. While you are free to add and change any of

5100

these objects later on the size of the world is fixed and can not be changed.

5101

5102

Thus subsequent code lines should <a href="#add">add</a> other objects, draw additional

5103

maps of objects and finalize some objects. The most common statement for such

5104

a finalization is the <a href="#shuffleOxyd">shuffleOxyd</a> method. It needs to know all

5105

<a href="#st_005foxyd">st_oxyd</a> to be able to color and shuffle them. Another finalization may

5106

be a custom rendering of a maze, that extracts the maze shape out of the

5107

level map (see section <a href="#res_002emaze">res.maze</a>).

5108

5109

This post world creation code may well have the need of loops or even some

5110

local used functions that need to be integrated to precede. Please keep such

5111

functions near by their usage and within the same code section.

5112

5113

Another set of functions that you may want to add are <a href="#Callbacks-and-Load-Balancing">Callbacks and Load Balancing</a>. We recommend to append these functions as the last section as they

5114

are not called within the level initialization itself.

5115

5116

But there is one very special exception. The <code>postinit()</code> callback is

5117

called after the level initialization code has been processed and all subsequent

5118

engine internal initialization has been finished. If this function is present

5119

in a level it gets executed directly before the first mouse movement event gets

5120

processed. Thus you can rely within this function that all objects are set up

5121

in their final state. If you have need of such a postinit callback you should

5122

put it after all the level intialization code and in front of other callback

5123

functions that will be executed on subsequent events.

5124

5125

5126

5127

5128

5129

5130

5131

5132

5133

5134

5135

5136

5137

5138

5139

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

5140

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

5141

5142

</tr></table>

5143

5144

<h3 class="subsection">4.4.4 Object Transformation</h3>

5145

5146

During runtime some Enigma objects do transform into other successor objects,

5147

like an <a href="#st_005fblocker">st_blocker</a>/<a href="#it_005fblocker">it_blocker</a>, an <a href="#st_005fbrake">st_brake</a>/<a href="#it_005fbrake">it_brake</a>,

5148

an <a href="#it_005frubberband">it_rubberband</a>/<a href="#ot_005frubberband">ot_rubberband</a>, an <a href="#it_005fhammer">it_hammer</a>/<a href="#it_005fsword">it_sword</a>,...

5149

5150

Even though the successor object may have other attributes, some attributes and

5151

especially any user attributes should be maintained. In fact the objects name,

5152

its target and action attributes and all attributes starting with an underscore

5153

‘<samp>_</samp>’, the user attributes, are transferred to the successor object. Thus you

5154

can rely on the successor to message the same target and you can it access it

5155

via its old name.

5156

5157

5158

5159

5160

5161

5162

5163

5164

5165

5166

5167

5168

5169

5170

5171

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

5172

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

5173

5174

</tr></table>

5175

5176

<h3 class="subsection">4.4.5 Named Positions</h3>

5177

5178

Many stones are movable and if the user can not push them, most may still be

5179

swapped. Items may be picked up by actors or be killed in a burning fire. Thus

5180

in most cases it is preferable to mark anchors or shapes in the floor. On every

5181

grid position a floor object is guaranteed and they are much more stable than

5182

other objects. But nevertheless a user may push an <a href="#st_005fbox">st_box</a>, an

5183

<a href="#st_005fpuzzle">st_puzzle</a> or other floor building stone on an <a href="#fl_005fwater">fl_water</a> or

5184

<a href="#fl_005fabyss">fl_abyss</a>. Furthermore a user may drop and ignite an <a href="#it_005fbomb">it_bomb</a> that

5185

destructs the floor leaving a new <a href="#fl_005fabyss">fl_abyss</a>. In all these cases you may

5186

loose a named anchor or an essential part of a named grid area accessible as

5187

an object group.

5188

5189

Thus for every named floor that gets killed its position is stored in a

5190

repository under its name. You just need to retrieve the named positions

5191

instead of the named objects if you want to get all affected floor positions.

5192

5193

<table><tr><td> </td><td><pre class="example">ti["~"] = {"fl_water", "water#"}

5194

...

5195

function sweet()

5196

wo[po["water#*"]] = {"it_cherry"}

5197

end

5198

</pre></td></tr></table>

5199

5200

Note that a request for a named position will include all positions of matching

5201

named objects as well as those named positions derived from killed floors.

5202

5203

5204

5205

5206

5207

5208

5209

5210

5211

5212

5213

5214

5215

5216

5217

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

5218

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

5219

5220

</tr></table>

5221

5222

<h3 class="subsection">4.4.6 Callbacks and Load Balancing</h3>

5223

5224

The most flexible feature for a level author to establish an unique behaviour

5225

of his level are <a href="#Callback-Function">Callback Function</a>s.

5226

5227

<a href="#Target-_002d-Action">Target - Action</a> kill warning

5228

<a href="#ot_005ftimer">ot_timer</a>

5229

5230

global and res.*.function

5231

5232

5233

5234

5235

5236

5237

5238

5239

5240

5241

5242

5243

5244

5245

5246

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

5247

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

5248

5249

</tr></table>

5250

5251

<h3 class="subsection">4.4.7 Level Restart</h3>

5252

5253

5254

5255

5256

5257

5258

5259

5260

5261

5262

5263

5264

5265

5266

5267

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

5268

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

5269

5270

</tr></table>

5271

5272

<h3 class="subsection">4.4.8 Ending Conditions</h3>

5273

5274

Two essential questions remain to be answered. When and under which conditions

5275

is a level successfully finished. How do I declare a level as being a

5276

meditation level in opposite to a standard oxyd pair opening level.

5277

5278

In fact there is no ’meditation’ flag, neither within the XML Level

5279

<a href="#Info-metadata">Info metadata</a> nor as one of the <a href="#Global-Attributes">Global Attributes</a>. That means there

5280

is no formal distinction between both level ’types’. But there are two different

5281

types of ending conditions. Both are checked permanently and whichever

5282

is fulfilled first wins. Thus Enigma allows you to write true hybrid levels

5283

that provide <a href="#st_005foxyd">st_oxyd</a> as well as <a href="#it_005fmeditation">it_meditation</a> allowing the user

5284

to solve the level by two totally different means.

5285

5286

The main way to end the game is to fulfill the oxyd pair opening condition:

5287

5288

The game is over when the user succeeds in opening all regular colored

5289

<a href="#st_005foxyd">st_oxyd</a>s by pairs.

5290

5291

This implies that there is at least one pair of regular colored oxyd stones

5292

and that all oxyd colors appear in even number of instances. Whereas you will

5293

always add at least one pair of oxyds for a standard level, you may simply loose

5294

track of the number of instances. Therefore the engine will permanently check at

5295

runtime that every oxyd color appears in an even number of instances. Any

5296

violation causes an error. In case you will add or delete oxyd stones you

5297

need to disable this checking by setting the global attribute

5298

<a href="#AllowSingleOxyds">AllowSingleOxyds</a> to <code>true</code>. Now it is your reponsibility as an

5299

author to ensure that the level remains solvable by adding or removing pairs

5300

only.

5301

5302

The second way to end the game is to fulfill the meditation condition:

5303

5304

All <a href="#ac_005fpearl">ac_pearl</a>s must reside for at least one second within the uneven area

5305

of an <a href="#it_005fmeditation">it_meditation</a>, all <a href="#it_005fmeditation">it_meditation</a> marked as <code>essential</code>

5306

must be occupied and the number of <a href="#ac_005fpearl">ac_pearl</a>s must be equal to the number

5307

of occupied <a href="#it_005fmeditation">it_meditation</a>s.

5308

5309

This implies again that there exists at least one <a href="#ac_005fpearl">ac_pearl</a> and that

5310

no two pearls can reside within the same <a href="#it_005fmeditation">it_meditation</a>. There must be at

5311

least the same number of <a href="#it_005fmeditation">it_meditation</a> as of <a href="#ac_005fpearl">ac_pearl</a>, but there may

5312

be more <a href="#it_005fmeditation">it_meditation</a>s as long as they are not marked as being essential.

5313

A surplus of <a href="#it_005fmeditation">it_meditation</a> can easily occur due to explosions of

5314

<a href="#it_005fdynamite">it_dynamite</a>.

5315

5316

A level that should be solved by fulfillment of the meditation condition can

5317

contain <a href="#st_005foxyd">st_oxyd</a> and by setting <a href="#AllowSingleOxyds">AllowSingleOxyds</a> to <code>true</code> you

5318

can add odd numbers of oxyd stones of a color. On the other hand you can add

5319

<a href="#ac_005fpearl">ac_pearl</a> to a level that should be solved by fulfillment of the oxyd pair

5320

condition. But you must carefully check that the user can not rest the pearls in

5321

given <a href="#it_005fmeditation">it_meditation</a> or can create <a href="#it_005fmeditation">it_meditation</a> by <a href="#it_005fdynamite">it_dynamite</a>.

5322

Marking more <a href="#it_005fmeditation">it_meditation</a> as <code>essential</code> than existing

5323

<a href="#ac_005fpearl">ac_pearl</a>s can avoid shortcuts.

5324

5325

A level that is set up to allow the user to fulfill both conditions is called

5326

a hybrid level. Of course it is a difficult task to provide equivalent solutions

5327

for both approaches.

5328

5329

Independent of the condition type all actors marked as <code>essential</code> need to

5330

be alive at the moment the condition is fulfilled. Mainly in existing legacy

5331

levels but may in some very carefully designed future levels the author may

5332

allow the user to sacrify an actor to fulfill the condition by setting the

5333

global attribute <a href="#SurviveFinish">SurviveFinish</a> to <code>false</code>. In this case a mable

5334

may shatter while the condition is fulfilled. Of course the essential actor

5335

may not shatter in advance, because as soon as the shattering is over the

5336

essential actor will cause a level restart, if it can not be resurrected.

5337

5338

5339

5340

5341

5342

5343

5344

5345

5346

5347

5348

5349

5350

5351

5352

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

5353

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

5354

5355

</tr></table>

5356

5357

5358

5359

Knowing the basic principles of an Enigma level’s world you now just need

5360

the language glue to write your first level. Enigma levels are written in

5361

the language <a href="http://www.lua.org">Lua</a> as of version 5.1.4. This powerful

5362

language gives you the ability to write most complex, dynamical levels, while

5363

being nearly transparent on writing basic standard levels. Indeed there is no

5364

reason to dig into this language at the very beginning.

5365

5366

With the second Lua API version, as of Enigma 1.10, we designed an optimized

5367

way of describing levels in a very short and readable manner. Thus we would like

5368

to introduce you to this API by giving several examples from a basic level to most

5369

thrilling dynamic real Enigma levels. You should be able to start your first

5370

experiments just after reading the first example with its explanations.

5371

5372

For your convenience we do color the Lua code part. Predefined Lua variables and

5373

functions are colored in green. Enigma internal string constants as object kinds,

5374

attribute or message names are colored in blue. Level specific variable names

5375

and value constants are colored in magenta.

5376

5377

After the examples and a short overview the details of the language specific API

5378

part are given, as you can expect it for a reference manual. Please note

5379

that additional <a href="#Advanced-Features">Advanced Features</a> are described in a separate chapter.

5380

5381

5382

<tr><td align="left" valign="top"><a href="#Basic-Lua-Examples">5.1 Basic Lua Examples</a></td><td>  </td><td align="left" valign="top">

5383

</td></tr>

5384

<tr><td align="left" valign="top"><a href="#API-2-Overview">5.2 API 2 Overview</a></td><td>  </td><td align="left" valign="top">

5385

</td></tr>

5386

<tr><td align="left" valign="top"><a href="#Advanced-Lua-Examples">5.3 Advanced Lua Examples</a></td><td>  </td><td align="left" valign="top">

5387

</td></tr>

5388

<tr><td align="left" valign="top"><a href="#Introduction-to-Datatypes">5.4 Introduction to Datatypes</a></td><td>  </td><td align="left" valign="top">

5389

</td></tr>

5390

<tr><td align="left" valign="top"><a href="#Position">5.5 Position</a></td><td>  </td><td align="left" valign="top">

5391

</td></tr>

5392

<tr><td align="left" valign="top"><a href="#Object">5.6 Object</a></td><td>  </td><td align="left" valign="top">

5393

</td></tr>

5394

<tr><td align="left" valign="top"><a href="#Group">5.7 Group</a></td><td>  </td><td align="left" valign="top">

5395

</td></tr>

5396

<tr><td align="left" valign="top"><a href="#NamedObjects">5.8 NamedObjects</a></td><td>  </td><td align="left" valign="top">

5397

</td></tr>

5398

<tr><td align="left" valign="top"><a href="#PositionList">5.9 PositionList</a></td><td>  </td><td align="left" valign="top">

5399

</td></tr>

5400

<tr><td align="left" valign="top"><a href="#Positions-Repository">5.10 Positions Repository</a></td><td>  </td><td align="left" valign="top">

5401

</td></tr>

5402

<tr><td align="left" valign="top"><a href="#Tile-and-Object-Declaration">5.11 Tile and Object Declaration</a></td><td>  </td><td align="left" valign="top">

5403

</td></tr>

5404

<tr><td align="left" valign="top"><a href="#Tiles-Repository">5.12 Tiles Repository</a></td><td>  </td><td align="left" valign="top">

5405

</td></tr>

5406

<tr><td align="left" valign="top"><a href="#World">5.13 World</a></td><td>  </td><td align="left" valign="top">

5407

</td></tr>

5408

<tr><td align="left" valign="top"><a href="#Functions">5.14 Functions</a></td><td>  </td><td align="left" valign="top">

5409

</td></tr>

5410

5411

</pre></th></tr></table>

5412

5413

5414

5415

5416

5417

5418

5419

5420

5421

5422

5423

5424

5425

5426

5427

5428

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

5429

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

5430

5431

</tr></table>

5432

5433

<h2 class="section">5.1 Basic Lua Examples</h2>

5434

5435

Let us look at two basic onescreener levels, that make use of all basic

5436

techniques. While the first level is a little bit artificial, as it is designed

5437

for demo purposes only, the second one is a quite dynamic real level out of

5438

the Enigma levelpacks.

5439

5440

5441

<tr><td align="left" valign="top"><a href="#Basic-Example">5.1.1 Basic Example</a></td><td>  </td><td align="left" valign="top">

5442

</td></tr>

5443

<tr><td align="left" valign="top"><a href="#Colored-Turnstiles">5.1.2 Colored Turnstiles</a></td><td>  </td><td align="left" valign="top"> Enigma Levelpack VIII, level #?

5444

</td></tr>

5445

</table>

5446

5447

5448

5449

5450

5451

5452

5453

5454

5455

5456

5457

5458

5459

5460

5461

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

5462

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

5463

5464

</tr></table>

5465

5466

<h3 class="subsection">5.1.1 Basic Example</h3>

5467

5468

Let us view the source code. We did add a line count in the first two columns

5469

for reference purpose within this section. These line count numbers are not part

5470

of the source code itself!

5471

5472

5473

2 <el:level xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://enigma-game.org/schema/level/1 level.xsd" xmlns:el="http://enigma-game.org/schema/level/1">

5474

3 <el:protected>

5475

4 <el:info el:type="level">

5476

5 <el:identity el:title="Basic Level" el:subtitle="" el:id="20080721ral513"/>

5477

6 <el:version el:score="1" el:release="1" el:revision="$Revision: 1170 $" el:status="experimental"/>

5478

7 <el:author el:name="Ronald Lamprecht" el:email="ral@users.berlios.de"/>

5479

5480

9 <el:license el:type="GPL v2.0 or above" el:open="true"/>

5481

10 <el:compatibility el:enigma="<var>1.10</var>"/>

5482

11 <el:modes el:easy="true" el:single="true" el:network="false"/>

5483

12 <el:score el:easy="-" el:difficult="-"/>

5484

13 </el:info>

5485

14 <el:luamain><![CDATA[

5486

15

5487

16 wo["ConserveLevel"] = <var>true</var>

5488

17

5489

18 ti["<var> </var>"] = {"fl_samba"}

5490

19 ti["<var>.</var>"] = {"fl_abyss"}

5491

20 ti["<var>~</var>"] = {"fl_water"}

5492

21 ti["<var>#</var>"] = {"st_granite"}

5493

22 ti["<var>X</var>"] = {"st_oxyd"}

5494

23

5495

24 ti["<var>L</var>"] = {"st_laser", orientation=<var>EAST</var>, state=<var>ON</var>}

5496

25 ti["<var>M</var>"] = {"st_lightpassenger", interval=<var>0.04</var>}

5497

26

5498

27 ti["<var>P</var>"] = {"st_polarswitch", name="<var>polar</var>"}

5499

28 ti["<var>T</var>"] = {"it_trigger", target="<var>polar</var>"}

5500

29

5501

30 ti["<var>^</var>"] = {"st_boulder", "<var>boulder</var>", orientation=<var>NORTH</var>}

5502

31 ti["<var>F</var>"] = {"st_fourswitch", target="<var>boulder</var>", action="<var>orientate</var>"}

5503

32

5504

33 ti["<var>D</var>"] = {"st_door_d", "<var>door</var>", faces="<var>ew</var>"}

5505

34 ti["<var>B</var>"] = {"it_blocker", "<var>wall#</var>"}

5506

35 ti["<var>S</var>"] = {"st_switch", target={"<var>door</var>", "<var>wall#*</var>"}}

5507

36

5508

37 ti["<var>v</var>"] = {"it_vortex", "<var>left</var>", destination="<var>right</var>"}

5509

38 ti["<var>V</var>"] = {"it_vortex", "<var>right</var>", destination="<var>left</var>"}

5510

39

5511

40 ti["<var>O</var>"] = {"st_turnstile", flavor="<var>red</var>"}

5512

41 ti["<var>E</var>"] = {"st_turnstilearm", orientation=<var>EAST</var>}

5513

42 ti["<var>N</var>"] = ti["<var>.</var>"] .. {"st_turnstilearm_n"}

5514

43

5515

44 ti["<var>+</var>"] = {"fl_samba", checkerboard=<var>0</var>} .. ti({"fl_wood", checkerboard=<var>1</var>})

5516

45

5517

46 ti["<var>1</var>"] = {"#ac_marble"}

5518

47

5519

48 if wo["IsDifficult"] then

5520

49 ti["<var>=</var>"] = ti["<var>~</var>"]

5521

50 else

5522

51 ti["<var>=</var>"] = ti["<var>~</var>"] .. {"it_strip_ew"}

5523

52 end

5524

53

5525

54 w, h = wo(ti, "<var> </var>", {

5526

55 "<var>####################</var>",

5527

56 "<var># ....++++++~ #</var>",

5528

57 "<var>L PM ..N.++~~~~OE#</var>",

5529

58 "<var>####### T~++++++. #</var>",

5530

59 "<var># ^ ~++++++# #</var>",

5531

60 "<var># =++++++X X</var>",

5532

61 "<var># ~++++++# #</var>",

5533

62 "<var>#~~~~~~~~~~~~~+++X X</var>",

5534

63 "<var># ~ B ~+++###</var>",

5535

64 "<var>F ~ B ~+++++#</var>",

5536

65 "<var># 1 ~ B #+++++#</var>",

5537

66 "<var>S v~V B D+++++#</var>",

5538

67 "<var>####################</var>"

5539

68 })

5540

69

5541

70 wo:shuffleOxyd()

5542

71

5543

72 ]]></el:luamain>

5544

73 <el:i18n>

5545

74 <el:string el:key="title">

5546

75 <el:english el:translate="false"/>

5547

76 </el:string>

5548

77 </el:i18n>

5549

78 </el:protected>

5550

79 </el:level>

5551

</pre></td></tr></table>

5552

5553

The resulting level looks like this in the game

5554

5555

5556

5557

Let us now analyse the code line by line.

5558

5559

Lines 1 to 14 are the XML metadata of the level as described in

5560

<a href="#Level-Basics">Level Basics</a>. The only line worth mentioning is

5561

5562

</pre></td></tr></table>

5563

5564

You need to declare the level to be compatible to Enigma 1.10 or higher for

5565

the new API 2 as described in this reference manual. A value less than 1.10

5566

indicates compatibility to a previous Enigma release that did use the old API 1,

5567

which should not be mixed up with the new API 2.

5568

5569

The Lua part starts with line 15:

5570

<table><tr><td> </td><td><pre class="example">16 wo["ConserveLevel"] = <var>true</var>

5571

</pre></td></tr></table>

5572

5573

Like most levels it starts with setting <a href="#Global-Attributes">Global Attributes</a>. The handle of

5574

our world is ‘<samp>wo</samp>’. This object reference is preset

5575

(see section <a href="#World-as-an-Object">World as an Object</a>). Concerning Lua it is an ‘<samp>userdata</samp>’,

5576

but most of its usage syntax is identical to that of Lua tables. Thus we access

5577

an attribute by providing the desired attribute name in square brackets. As we

5578

give a literal attribute name, we have to put it in double quotes ‘<samp>"</samp>’. In

5579

total this line requests the world to resurrect a killed actor as long as there

5580

are enough extra lifes to conserve the running level (see section <a href="#ConserveLevel">ConserveLevel</a>).

5581

In fact ‘<samp>true</samp>’ is the default value. So we could have left this line out.

5582

But remember it is a demo level.

5583

5584

The second part of a level are the tile definitions as explained in

5585

<a href="#World_0027s-Shape-and-Coordinates">World’s Shape and Coordinates</a>. Let us start with the most simple ones:

5586

<table><tr><td> </td><td><pre class="example">18 ti["<var> </var>"] = {"fl_samba"}

5587

19 ti["<var>.</var>"] = {"fl_abyss"}

5588

20 ti["<var>~</var>"] = {"fl_water"}

5589

21 ti["<var>#</var>"] = {"st_granite"}

5590

22 ti["<var>X</var>"] = {"st_oxyd"}

5591

</pre></td></tr></table>

5592

5593

Again we use a handle ‘<samp>ti</samp>’ which is a preset object reference for the

5594

tile definition repository. Like the world it is a Lua ‘<samp>userdata</samp>’. And

5595

we can access it like the world by giving the desired index in square brackets.

5596

These indices are free to your choice. They have to be of a common character length

5597

if they are referenced in the world map below. For a small level one character

5598

keys are sufficient. You can use any ASCII character that Lua is aware of. That

5599

means upper and lower case characters ‘<samp>A-Z,a-z</samp>’, the numbers and special

5600

characters besides backslash ‘<samp>\</samp>’ and double quote ‘<samp>"</samp>’.

5601

5602

The assigned object definition are given as Lua anonymous tables, the curly braces,

5603

containing in the most simple case just the desired <a href="#Object-Kind">Object Kind</a>. As it

5604

is again a literal string, it has to be quoted. Without any further specification

5605

the objects are taken in their default configuration as described in

5606

<a href="#Floor-Objects">Floor Objects</a> and following chapters.

5607

5608

<table><tr><td> </td><td><pre class="example">24 ti["<var>L</var>"] = {"st_laser", orientation=<var>EAST</var>, state=<var>ON</var>}

5609

25 ti["<var>M</var>"] = {"st_lightpassenger", interval=<var>0.04</var>}

5610

</pre></td></tr></table>

5611

5612

These two lines define objects with custom configuration. The <a href="#st_005flaser">st_laser</a>

5613

should send its beam to the east and should start being switched on. The

5614

<a href="#st_005flightpassenger">st_lightpassenger</a> should move a little bit faster than usually. Both

5615

times we just have to add comma separated additional attributes. The attribute

5616

names are not quoted as they are followed by an equal ‘<samp>=</samp>’ sign.

5617

5618

<table><tr><td> </td><td><pre class="example">27 ti["<var>P</var>"] = {"st_polarswitch", name="<var>polar</var>"}

5619

28 ti["<var>T</var>"] = {"it_trigger", target="<var>polar</var>"}

5620

</pre></td></tr></table>

5621

5622

An <a href="#st_005fpolarswitch">st_polarswitch</a> named for reference usage (see section <a href="#Object-Naming">Object Naming</a>).

5623

The <a href="#it_005ftrigger">it_trigger</a> sets up a <a href="#Target-_002d-Action">Target - Action</a>, the target being our

5624

polarswitch. The action attribute is omitted. It defaults to the message

5625

‘<samp>toggle</samp>’. Thus any actor or stone on top of the trigger makes the

5626

polarswitch transparent, but switches it back to opacity when leaving

5627

the trigger.

5628

5629

<table><tr><td> </td><td><pre class="example">30 ti["<var>^</var>"] = {"st_boulder", "<var>boulder</var>", orientation=<var>NORTH</var>}

5630

31 ti["<var>F</var>"] = {"st_fourswitch", target="<var>boulder</var>", action="<var>orientate</var>"}

5631

</pre></td></tr></table>

5632

5633

Another pair of objects that are coupled by <a href="#Target-_002d-Action">Target - Action</a>. The

5634

<a href="#st_005fboulder">st_boulder</a> starts trying to move to north. This time we name the object

5635

just by giving the name as the second comma separated string. We omitted the

5636

attribute identifier ‘<samp>name =</samp>’. This is a shortcut for this most common

5637

attribute which requires the name to be given as the second value directly

5638

after the objects kind.

5639

5640

The <a href="#st_005ffourswitch">st_fourswitch</a> references the boulder as its target. We need to give

5641

the action as well, as we want to make use of a special action that directly

5642

steers the boulder according to the fourswitch orientation.

5643

5644

<table><tr><td> </td><td><pre class="example">33 ti["<var>D</var>"] = {"st_door_d", "<var>door</var>", faces="<var>ew</var>"}

5645

34 ti["<var>B</var>"] = {"it_blocker", "<var>wall#</var>"}

5646

35 ti["<var>S</var>"] = {"st_switch", target={"<var>door</var>", "<var>wall#*</var>"}}

5647

</pre></td></tr></table>

5648

5649

And another even more complex <a href="#Target-_002d-Action">Target - Action</a>. We want a single

5650

<a href="#st_005fswitch">st_switch</a> to toggle a <a href="#st_005fdoor">st_door</a> as well as set of <a href="#it_005fblocker">it_blocker</a>s

5651

at the same time. The gaming idea is that neither with switch on nor with switch

5652

off the marble can pass both obstacles. The gamer needs to steer the boulder

5653

through the blocker wall to pass these obstacles.

5654

5655

The setup of the door is simple. We just need to name it to be able to reference

5656

it later on. We want to use several blocker objects and we need to name each

5657

for reference purposes. We do this by appending a hash sign ‘<samp>#</samp>’ to its

5658

name as described in <a href="#Object-Naming">Object Naming</a>. Every blocker gets a unique name.

5659

The switch needs to list all these objects as its targets. This is done by

5660

an embedded anonymous table given by the curly braces and comma separated

5661

values. The first one is our door’s name, the second one is a wildcarded string

5662

that describes all our blocker objects. The asterisk stands for any suffix

5663

that may have been added behind the hash in the process of autonaming of our

5664

blockers.

5665

5666

<table><tr><td> </td><td><pre class="example">37 ti["<var>v</var>"] = {"it_vortex", "<var>left</var>", destination="<var>right</var>"}

5667

38 ti["<var>V</var>"] = {"it_vortex", "<var>right</var>", destination="<var>left</var>"}

5668

</pre></td></tr></table>

5669

5670

We want to use two <a href="#it_005fvortex">it_vortex</a> that are connected to each other allowing

5671

the marble to warp into both directions. We set up both vortices with a unique

5672

name and add the attribute ‘<samp>destination</samp>’ referencing the other vortex’ name.

5673

5674

Note that it is no problem to reference the right vortex in line 37 while it

5675

is named later on in line 38. We are still just defining tiles and not creating

5676

any objects at all.

5677

5678

<table><tr><td> </td><td><pre class="example">40 ti["<var>O</var>"] = {"st_turnstile", flavor="<var>red</var>"}

5679

41 ti["<var>E</var>"] = {"st_turnstilearm", orientation=<var>EAST</var>}

5680

42 ti["<var>N</var>"] = ti["<var>.</var>"] .. {"st_turnstilearm_n"}

5681

</pre></td></tr></table>

5682

5683

Another object group is an <a href="#st_005fturnstile">st_turnstile</a> cluster with one arm disconnected.

5684

The first two definitions are straight forward. But in line 42 we precede the

5685

arm’s definition by another tile reference. It is the abyss tile defined in

5686

line 19. By concatenation, the two dots .., of a tile and an object

5687

definition we can define a new tile that is composed of both objects. In this

5688

case we define a turnstile arm on top of an abyss floor.

5689

5690

You may be wondering why we did not define floors for the other stone and item

5691

tiles. We make use of the tile definition in line 18 that we will declare

5692

later as the default floor for our level. Thus any tile declaration that does

5693

not provide its own floor will set this default floor.

5694

5695

<table><tr><td> </td><td><pre class="example">44 ti["<var>+</var>"] = {"fl_samba", checkerboard=<var>0</var>} .. ti({"fl_wood", checkerboard=<var>1</var>})

5696

</pre></td></tr></table>

5697

5698

Just for fun we want to provide a checkerboard floor on the right side of our

5699

level. This can be done by usage of the <a href="#checkerboard">checkerboard</a> attribute. Again

5700

we concatenate two object definitions for a single tile. Both are floors. That

5701

means for each grid position we try to set both floor types, but just one meets

5702

the checkerboard condition and will be set.

5703

5704

Please notice that we did convert one the floor object definitions to a tile

5705

definition by the function call ‘<samp>ti()</samp>’. This is necessary as Lua does not

5706

know how to concatenate two anonymous tables. One argument of the concatenation

5707

has to be a tile.

5708

5709

<table><tr><td> </td><td><pre class="example">46 ti["<var>1</var>"] = {"#ac_marble"}

5710

</pre></td></tr></table>

5711

5712

Finally we do need our marble. Unlike other objects it can be positioned

5713

anywhere within a grid. The most common position is the center of the grid.

5714

This is simply done by preceding the actor’s kind by a hash sign ‘<samp>#</samp>’.

5715

5716

<table><tr><td> </td><td><pre class="example">48 if wo["IsDifficult"] then

5717

49 ti["<var>=</var>"] = ti["<var>~</var>"]

5718

50 else

5719

51 ti["<var>=</var>"] = ti["<var>~</var>"] .. {"it_strip_ew"}

5720

52 end

5721

</pre></td></tr></table>

5722

5723

We encourage every level author to provide an easy mode for the levels. This

5724

is an example how to define mode dependent tiles. Like in line 16 we access

5725

a world attribute. But this time it is a read access of <a href="#IsDifficult">IsDifficult</a>.

5726

In easy mode we want an <a href="#it_005fstrip">it_strip</a> on top of the water floor that allows the

5727

marble to pass and press the trigger. In difficult mode there should be

5728

no passage. Thus the special tile is identical to the water tile defined in

5729

line 20.

5730

5731

<table><tr><td> </td><td><pre class="example">54 w, h = wo(ti, "<var> </var>", {

5732

55 "<var>####################</var>",

5733

56 "<var># ....++++++~ #</var>",

5734

57 "<var>L PM ..N.++~~~~OE#</var>",

5735

58 "<var>####### T~++++++. #</var>",

5736

59 "<var># ^ ~++++++# #</var>",

5737

60 "<var># =++++++X X</var>",

5738

61 "<var># ~++++++# #</var>",

5739

62 "<var>#~~~~~~~~~~~~~+++X X</var>",

5740

63 "<var># ~ B ~+++###</var>",

5741

64 "<var>F ~ B ~+++++#</var>",

5742

65 "<var># 1 ~ B #+++++#</var>",

5743

66 "<var>S v~V B D+++++#</var>",

5744

67 "<var>####################</var>"

5745

68 })

5746

</pre></td></tr></table>

5747

5748

After all tiles have been defined we can create our world simply by a map that

5749

uses our tile keys. The first argument is our handle ‘<samp>ti</samp>’, that defines

5750

how the keys should be resolved. The second argument is the key of our default

5751

floor. The third argument is the map as a table of strings, one for every line.

5752

5753

The world initialization returns the width and height of our world which are

5754

calculated by the map’s size.

5755

5756

<table><tr><td> </td><td><pre class="example">70 wo:shuffleOxyd()

5757

</pre></td></tr></table>

5758

5759

After the world is created and all objects are set, we can do some final

5760

postprocessing before the level starts to run. The most common task is the

5761

shuffling of the oxyds, which is just a method call of <a href="#shuffleOxyd">shuffleOxyd</a> to

5762

our mighty world object.

5763

5764

5765

5766

5767

5768

5769

5770

5771

5772

5773

5774

5775

5776

5777

5778

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

5779

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

5780

5781

</tr></table>

5782

5783

<h3 class="subsection">5.1.2 Colored Turnstiles</h3>

5784

5785

As this level is part of the Enigma levelpacks we recommend that you play

5786

the level first to get familiar with the used objects and their behaviour.

5787

5788

Now let us look at the essential Lua source code part of the level to understand

5789

how such an idea can be realized with the new API

5790

5791

<table><tr><td> </td><td><pre class="example">ti["<var> </var>"] = {"fl_sahara"}

5792

ti["<var>#</var>"] = {"st_purplegray"}

5793

ti["<var>@</var>"] = {"#ac_marble_black", "<var>marble_black</var>"}

5794

5795

ti["<var>N</var>"] = {"st_turnstilearm_n"}

5796

ti["<var>S</var>"] = {"st_turnstilearm_s"}

5797

ti["<var>E</var>"] = {"st_turnstilearm_e"}

5798

ti["<var>W</var>"] = {"st_turnstilearm_w"}

5799

ti["<var>R</var>"] = {"st_turnstile", action = {"<var>open</var>", "<var>close</var>"}, target = {"<var>red</var>#*", "<var>green</var>#*"}}

5800

ti["<var>G</var>"] = {"st_turnstile", action = {"<var>close</var>", "<var>open</var>"}, target = {"<var>red</var>#*", "<var>green</var>#*"},

5801

flavor = "<var>green</var>"}

5802

ti["<var>r</var>"] = {"it_blocker", "<var>red</var>#"} .. ti({"fl_red"})

5803

ti["<var>g</var>"] = {"it_blocker", "<var>green</var>#"} .. ti({"fl_lawn"})

5804

5805

ti["<var>O</var>"] = {"st_oxyd", flavor = "<var>d</var>", oxydcolor = <var>OXYD_GREEN</var>}

5806

ti["<var>o</var>"] = {"st_oxyd", flavor = "<var>d</var>", oxydcolor = <var>OXYD_RED</var>}

5807

5808

<var>w</var>, <var>h</var> = wo(ti, "<var> </var>", {

5809

-- 01234567890123456789

5810

"<var>#O#####O############</var>",

5811

"<var># r N g N rO##O#O#</var>",

5812

"<var>#WRE#WGE# R ####g#r#</var>",

5813

"<var># r N r S r N #</var>",

5814

"<var>#g#g#WG #g##r# REr##</var>",

5815

"<var># # N S r g S gO</var>",

5816

"<var>#@g RE#g#gWGE###g###</var>",

5817

"<var># # S g r N ro</var>",

5818

"<var>#r#r#WGE#r##g#WGEg##</var>",

5819

"<var># N r S g N r #</var>",

5820

"<var>#WGE# RE# RE####r#g#</var>",

5821

"<var># g S r S go##o#o#</var>",

5822

"<var>#o#####o############</var>"

5823

})

5824

5825

wo:shuffleOxyd()

5826

</pre></td></tr></table>

5827

5828

There are just four tile definitions that do all the dynamic actions. Let us

5829

look first at the blocker item definitions:

5830

5831

<table><tr><td> </td><td><pre class="example">ti["<var>r</var>"] = {"it_blocker", "<var>red</var>#"} .. ti({"fl-red"})

5832

ti["<var>g</var>"] = {"it_blocker", "<var>green</var>#"} .. ti({"fl-leaves"})

5833

</pre></td></tr></table>

5834

All blockers on red floors are autonamed with a name being composed of the

5835

prefix ‘<samp>red#</samp>’ and a unique random number being added by the engine as

5836

explained in <a href="#Object-Naming">Object Naming</a>. This allows us to address all these blockers

5837

later on.

5838

5839

<table><tr><td> </td><td><pre class="example">ti["<var>R</var>"] = {"st_turnstile", action = {"<var>open</var>", "<var>close</var>"}, target = {"<var>red</var>#*", "<var>green</var>#*"}}

5840

ti["<var>G</var>"] = {"st_turnstile", action = {"<var>close</var>", "<var>open</var>"}, target = {"<var>red</var>#*", "<var>green</var>#*"},

5841

flavor = "<var>green</var>"}

5842

</pre></td></tr></table>

5843

Whenever the marble hits and turns an <a href="#st_005fturnstile">st_turnstile</a> it performs its actions

5844

on the targets. Here the author makes clever usage of multitargets and

5845

multiactions as described in <a href="#Target-_002d-Action">Target - Action</a>. On every turn of a red

5846

turnstile all objects named ‘<samp>red#*</samp>’, that are all our blockers on a red

5847

floor, will be sent a message ‘<samp>open</samp>’, whereas all blocks on a green floor,

5848

the second target group, receives the second action message ‘<samp>close</samp>’. It is

5849

essential to choose the ‘<samp>open</samp>’, ‘<samp>close</samp>’ messages instead of

5850

‘<samp>toggle</samp>’, as more than one red turnstile may be turned in sequence, but

5851

just the first red turn should "toggle" all blockers. The next toggling should

5852

occur on the first green turn following thereafter.

5853

5854

Hope you got the basic idea of the new API. You may well start with you first

5855

level experiments. But you should return and read the following chapters with

5856

overview and advanced examples to write even more fancy levels.

5857

5858

5859

5860

5861

5862

5863

5864

5865

5866

5867

5868

5869

5870

5871

5872

5873

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

5874

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

5875

5876

</tr></table>

5877

5878

<h2 class="section">5.2 API 2 Overview</h2>

5879

5880

Having analysed a first level it is time get an overview of the API 2

5881

capabilities. Let us take a task driven approach by listing the different

5882

possibilities and use cases by example.

5883

5884

5885

<tr><td align="left" valign="top"><a href="#Types-Overview">5.2.1 Types Overview</a></td><td>  </td><td align="left" valign="top">

5886

</td></tr>

5887

<tr><td align="left" valign="top"><a href="#Position-Tasks">5.2.2 Position Tasks</a></td><td>  </td><td align="left" valign="top">

5888

</td></tr>

5889

<tr><td align="left" valign="top"><a href="#Attribute-Tasks">5.2.3 Attribute Tasks</a></td><td>  </td><td align="left" valign="top">

5890

</td></tr>

5891

<tr><td align="left" valign="top"><a href="#Object-Tasks">5.2.4 Object Tasks</a></td><td>  </td><td align="left" valign="top">

5892

</td></tr>

5893

<tr><td align="left" valign="top"><a href="#Group-Tasks">5.2.5 Group Tasks</a></td><td>  </td><td align="left" valign="top">

5894

</td></tr>

5895

<tr><td align="left" valign="top"><a href="#Tiles-and-World-Tasks">5.2.6 Tiles and World Tasks</a></td><td>  </td><td align="left" valign="top">

5896

</td></tr>

5897

<tr><td align="left" valign="top"><a href="#Named-Positions-Tasks">5.2.7 Named Positions Tasks</a></td><td>  </td><td align="left" valign="top">

5898

</td></tr>

5899

</table>

5900

5901

5902

5903

5904

5905

5906

5907

5908

5909

5910

5911

5912

5913

5914

5915

5916

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

5917

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

5918

5919

</tr></table>

5920

5921

<h3 class="subsection">5.2.1 Types Overview</h3>

5922

5923

But first we need to introduce you to the special Enigma value types besides

5924

the standard Lua types ‘<samp>nil</samp>’, ‘<samp>boolean</samp>’, ‘<samp>string</samp>’,

5925

‘<samp>function</samp>’ and ‘<samp>table</samp>’:

5926

5927

5928

<dt> Types:</dt>

5929

5930

<dt> position:  See section <a href="#Position">Position</a></dt>

5931

<dd>A position within the world that can be described by an x and y coordinate.

5932

</dd>

5933

<dt> positions: preset variable: <code>po</code>;   See section <a href="#Positions-Repository">Positions Repository</a></dt>

5934

<dd>The singleton type of the repository of all named positions.

5935

</dd>

5936

<dt> object:  See section <a href="#Object">Object</a></dt>

5937

<dd>An Enigma object like a stone, item, floor, other. Any object is a position, too.

5938

</dd>

5939

<dt> group:  See section <a href="#Group">Group</a></dt>

5940

<dd>A list of objects.

5941

</dd>

5942

<dt> namedobjects: preset variable: <code>no</code>;   See section <a href="#NamedObjects">NamedObjects</a></dt>

5943

<dd>The singleton type of the repository of all named objects.

5944

</dd>

5945

<dt> default: preset variable: <code>DEFAULT</code>;   See section <a href="#Object-Attributes">Object Attributes</a></dt>

5946

<dd>The singleton type of default values that can be used instead of Lua’s ‘<samp>nil</samp>’

5947

in anonymous table tile definitions.

5948

</dd>

5949

<dt> tile:  See section <a href="#Tile-and-Object-Declaration">Tile and Object Declaration</a></dt>

5950

<dd>A description of one or several objects for a common grid position (floor, item,

5951

stone, actor)

5952

</dd>

5953

<dt> tiles: preset variable: <code>ti</code>;   See section <a href="#Tiles-Repository">Tiles Repository</a></dt>

5954

<dd>The singleton type of the repository of all tile instances.

5955

</dd>

5956

<dt> world: preset variable: <code>wo</code>;   See section <a href="#World">World</a></dt>

5957

<dd>The singleton type of the world that contains all objects.

5958

</dd>

5959

<dt> position list:  See section <a href="#Named-Positions">Named Positions</a></dt>

5960

<dd>A list of positions.

5961

</dd>

5962

</dl>

5963

</dd>

5964

</dl>

5965

5966

Please note the four handles ‘<samp>po</samp>’, ‘<samp>no</samp>’, ‘<samp>ti</samp>’ and ‘<samp>wo</samp>’. You

5967

have noticed two of them in the previous section <a href="#Basic-Lua-Examples">Basic Lua Examples</a>. These

5968

are four variables, that are preset prior the level code gets executed.

5969

5970

API 2 uses mainly two character names for frequently used variables and

5971

functions to shorten the level code and to make it better readable. Authors

5972

should try to use either single characters or names that are three characters or

5973

longer for private variable names.

5974

5975

For the rest of this section let us assume that ‘<samp>obj</samp>’ is an object

5976

reference of a stone, item or floor, which means that is of type ‘<samp>object</samp>’.

5977

And let ‘<samp>pos</samp>’ be a valid variable of type ‘<samp>position</samp>’.

5978

5979

5980

5981

5982

5983

5984

5985

5986

5987

5988

5989

5990

5991

5992

5993

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

5994

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

5995

5996

</tr></table>

5997

5998

<h3 class="subsection">5.2.2 Position Tasks</h3>

5999

6000

For reference details see section <a href="#Position">Position</a>.

6001

6002

6003

<dt> Creating Positions:</dt>

6004

<dd><table><tr><td> </td><td><pre class="example"><var>pos</var> = po(<var>7</var>, <var>3</var>) -- using function "po()" to generate a position object

6005

<var>pos</var> = po({<var>7</var>, <var>3</var>}) -- using a table position constant as argument

6006

<var>pos</var> = <var>obj</var> -- every object is a valid position

6007

<var>pos</var> = po(<var>12.3</var>, <var>3.7</var>) -- a position within a grid (for an actor)

6008

</pre></td></tr></table>

6009

Absolute positions are created by the function ‘<samp>po()</samp>’. But the most common

6010

way should be the reinterpretation of an object as a position. This lets you

6011

set other objects relatively to given ones.

6012

6013

</dd>

6014

<dt> Position Constants:</dt>

6015

<dd><table><tr><td> </td><td><pre class="example">{<var>7</var>,<var>3</var>} -- a valid position for all arguments and operations (see <a href="#Caveats">Caveats</a>)

6016

</pre></td></tr></table>

6017

Anonymous tables with just two number values can be used in many cases directly as

6018

a position constant. In case of errors, e.g. when operators are not well defined

6019

like addition of two constants, which results in an attempt of adding two Lua

6020

tables, use the function ‘<samp>po()</samp>’ to convert the constant.

6021

6022

</dd>

6023

<dt> Coordinate Access:</dt>

6024

<dd><table><tr><td> </td><td><pre class="example"><var>x</var>, <var>y</var> = <var>pos</var>.x, <var>pos</var>.y

6025

<var>x</var>, <var>y</var> = <var>pos</var>["x"], pos["y"]

6026

<var>x</var>, <var>y</var> = <var>pos</var>:xy()

6027

<var>x</var>, <var>y</var> = <var>obj</var>.x, <var>obj</var>.y

6028

<var>x</var>, <var>y</var> = <var>obj</var>:xy()

6029

</pre></td></tr></table>

6030

The x and y coordinate of a position or object can be read accessed like any

6031

object attribute. A position or object method call by ‘<samp>xy()</samp>’ returns

6032

both coordinate values at once. You can not set a position value by coordinate

6033

write access. Objects need to be set to a new world position. New positions

6034

can be calculated by position arithmetic.

6035

6036

</dd>

6037

<dt> Position Calculation:</dt>

6038

<dd><table><tr><td> </td><td><pre class="example"><var>pos</var> = <var>obj</var> + {<var>2</var>,<var>7</var>}

6039

6040

6041

6042

</pre></td></tr></table>

6043

Positions can be added or subtracted to get distance vectors. You can multiply

6044

and divide them with any number.

6045

6046

</dd>

6047

<dt> Center positions for set actors</dt>

6048

<dd><table><tr><td> </td><td><pre class="example"><var>pos_centered1</var> = <var>pos</var> + {<var>0.5</var>, <var>0.5</var>}

6049

<var>pos_centered2</var> = #<var>pos</var>

6050

<var>pos_centered3</var> = #<var>obj</var>

6051

</pre></td></tr></table>

6052

Especially for positioning of actors you sometimes need the position of the

6053

center of a grid. Of course you can get it by addition of a constant position.

6054

But the ‘<samp>#</samp>’ operator applied on a position or an actor does the same in

6055

a simpler way.

6056

6057

</dd>

6058

<dt> Round a position to a grid</dt>

6059

<dd><table><tr><td> </td><td><pre class="example"><var>grid_pos</var> = <var>pos</var>:grid()

6060

<var>grid_pos</var> = ((<var>pos1</var> - <var>pos2</var>)/<var>2</var>):grid()

6061

</pre></td></tr></table>

6062

A result of a position calculation needs sometimes to be rounded to integer grid

6063

coordinates. This is done by the ‘<samp>grid()</samp>’ method.

6064

6065

</dd>

6066

<dt> Position comparison</dt>

6067

<dd><table><tr><td> </td><td><pre class="example"><var>pos_centered1</var> == <var>pos_centered2</var>

6068

<var>pos_centered1</var> ~= <var>pos_centered2</var> -- Lua's inequality operator

6069

</pre></td></tr></table>

6070

Position can be easily compared to equality.

6071

6072

</dd>

6073

<dt> Position existence</dt>

6074

<dd><table><tr><td> </td><td><pre class="example"><var>pos</var>:exists()

6075

</pre></td></tr></table>

6076

‘<samp>true</samp>’ if a position is a valid position of the world. All positions

6077

outside of the world return ‘<samp>false</samp>’.

6078

</dd>

6079

</dl>

6080

6081

6082

6083

6084

6085

6086

6087

6088

6089

6090

6091

6092

6093

6094

6095

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

6096

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

6097

6098

</tr></table>

6099

6100

<h3 class="subsection">5.2.3 Attribute Tasks</h3>

6101

6102

For reference details see section <a href="#Object">Object</a>.

6103

6104

6105

<dt> Single Attribute Setting:</dt>

6106

<dd><table><tr><td> </td><td><pre class="example"><var>obj</var>["destination"] = po(<var>7</var>,<var>3</var>)

6107

wo["Brittleness"] = <var>7</var>

6108

</pre></td></tr></table>

6109

Object attributes as well as global world attributes can be set like Lua table

6110

values. They can take values of special Enigma types like position, object or

6111

group.

6112

6113

</dd>

6114

<dt> Multiple Attribute Setting:</dt>

6115

<dd><table><tr><td> </td><td><pre class="example"><var>obj</var>:set({target=<var>mydoor</var>, action="open"})

6116

</pre></td></tr></table>

6117

You can set multiple attributes on any object at once with the objects ‘<samp>set()</samp>’

6118

method. The argument is an anonymous Lua table with the attribute names as keys

6119

and assigned values of your choice.

6120

6121

</dd>

6122

<dt> Requesting Attributes:</dt>

6123

<dd><table><tr><td> </td><td><pre class="example"><var>value</var> = <var>obj</var>["attr_name"]

6124

<var>value</var> = wo["Brittleness"]

6125

if wo["IsDifficult"] then ... end

6126

</pre></td></tr></table>

6127

Attributes of objects and the world can be read like Lua table key values.

6128

6129

</dd>

6130

<dt> Reset Attributes:</dt>

6131

<dd><table><tr><td> </td><td><pre class="example"><var>obj</var>["length"] = nil -- the default length, e.g. ‘<samp>1</samp>’

6132

<var>obj</var>["color"] = nil -- delete color attribute - no color

6133

<var>obj</var>["length"] = DEFAULT -- the default length, e.g. ‘<samp>1</samp>’

6134

</pre></td></tr></table>

6135

Any object attribute can be reset to its default value, which is the attribute’s

6136

"delete" operation, by assigning it the Lua ‘<samp>nil</samp>’ or the Enigma

6137

‘<samp>DEFAULT</samp>’ value.

6138

6139

</dd>

6140

</dl>

6141

6142

6143

6144

6145

6146

6147

6148

6149

6150

6151

6152

6153

6154

6155

6156

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

6157

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

6158

6159

</tr></table>

6160

6161

<h3 class="subsection">5.2.4 Object Tasks</h3>

6162

6163

For reference details see section <a href="#Object">Object</a>.

6164

6165

6166

<dt> Creating Objects:</dt>

6167

<dd><table><tr><td> </td><td><pre class="example">wo[<var>pos</var>] = {"st_chess", color=<var>WHITE</var>, name="<var>Atrax</var>"} -- on grid pos

6168

wo[#<var>pos</var>] = {"ac_bug"} -- actor centered on grid pos

6169

wo[<var>pos</var>] = {"#ac_bug"} -- actor centered on grid pos

6170

wo[<var>pos</var>] = {"ac_bug", <var>0.3</var>, <var>0.7</var>} -- actor with offsets to pos

6171

wo[<var>my_floor</var>] = {"it_magicwand"} -- set a wand on top of a given floor object

6172

wo[<var>pos</var>] = ti["<var>x</var>"] -- tile based object definition

6173

</pre></td></tr></table>

6174

Besides map based object creation, that you saw in the previous basic examples,

6175

you can create new objects on any world position directly. The world takes a

6176

position, that may well be an object, as key argument. The new object is

6177

described either by an anonymous Lua table, containing the kind string as first

6178

value and additional attributes as key value pairs appended, or by a tile object.

6179

6180

</dd>

6181

<dt> Object Naming:</dt>

6182

<dd><table><tr><td> </td><td><pre class="example">no["<var>Atrax</var>"] = <var>obj</var>

6183

wo[<var>pos</var>] = {"st_chess", name="<var>Atrax</var>"}

6184

wo[<var>pos</var>] = {"st_chess", "<var>Atrax</var>", color=<var>WHITE</var>}

6185

</pre></td></tr></table>

6186

As explained in <a href="#Object-Naming">Object Naming</a>, the names are the only longtime valid

6187

object references. You can explicitly name an object by assigning it at the

6188

named object repository ‘<samp>no</samp>’ to the name as the key. But most times you

6189

just supply the objects name as an object attribute. If you supply the name

6190

attribute as the second value in the anonymous table you can omit the

6191

key ‘<samp>name =</samp>’ part as a common abbreviation.

6192

6193

</dd>

6194

<dt> Object Autonaming:</dt>

6195

<dd><table><tr><td> </td><td><pre class="example">wo[<var>pos</var>] = {"st_chess", name="<var>Atrax</var>#"}

6196

</pre></td></tr></table>

6197

As explained in <a href="#Object-Naming">Object Naming</a> you can append a hash sign ‘<samp>#</samp>’ to a

6198

name and use the resulting string for arbitrary number of similar objects. This

6199

is especially useful for building groups.

6200

6201

</dd>

6202

<dt> Requesting Objects:</dt>

6203

<dd><table><tr><td> </td><td><pre class="example"><var>obj</var> = no["<var>Atrax</var>"] -- named object retrieval from repository

6204

<var>obj</var> = it(<var>pos</var>)

6205

<var>obj</var> = it(<var>x</var>,<var>y</var>)

6206

<var>obj</var> = st(<var>pos</var>)

6207

<var>obj</var> = wo:it(<var>pos</var>)

6208

<var>my_item</var> = it(<var>my_floor</var>) -- get the item that is on top of the given floor

6209

</pre></td></tr></table>

6210

The most common way is naming objects and the requesting the ‘<samp>no</samp>’

6211

repository for the object reference. If you know the position of the desired

6212

object you can use one of the functions or world methods ‘<samp>fl</samp>’, ‘<samp>it</samp>’,

6213

‘<samp>st</samp>’ that take a position, an object as position, or just the two

6214

coordinates as arguments. Especially requesting one type of objects that is

6215

positioned at the same grid as another object, the stone on top of a floor, etc.

6216

can be very useful.

6217

6218

</dd>

6219

<dt> Killing Objects:</dt>

6220

<dd><table><tr><td> </td><td><pre class="example">wo[<var>pos</var>] = {"it_nil"}

6221

<var>obj</var>:kill()

6222

</pre></td></tr></table>

6223

You remove an object by setting another replacement object at the same

6224

position in the same layer. If you do not want to set a new object you can use

6225

the placebo objects ‘<samp>fl_nil</samp>’, ‘<samp>it_nil</samp>’, ‘<samp>st_nil</samp>’. Another way is

6226

to call the ‘<samp>kill()</samp>’ method of an object or send it a ‘<samp>kill</samp>’ message.

6227

You can only remove objects that are set on the grid. Neither actors nor owned

6228

objects like items in a players inventory can be killed - they will simply

6229

ignore the attempt.

6230

6231

</dd>

6232

<dt> Comparing Objects</dt>

6233

6234

6235

</pre></td></tr></table>

6236

Objects can be directly compared on equality or inequality. It is an identity

6237

comparison that acknowledges that you have two references of the same object.

6238

6239

</dd>

6240

<dt> Existence of an object</dt>

6241

<dd><table><tr><td> </td><td><pre class="example"><var>obj</var>:exists()

6242

-<var>obj</var> -- unary minus operator on object

6243

if -<var>obj</var> then ...

6244

</pre></td></tr></table>

6245

Object references may get invalid due to objects being killed. In most cases

6246

this creates no problem as requests to invalid objects will simply be ignored.

6247

But if the level logic depends on the existence of an object you can call the

6248

‘<samp>exists()</samp>’ method or simply precede the reference by the unary minus

6249

‘<samp>-</samp>’ operator. Both ways return a simple bool value stating if the object

6250

reference is still valid.

6251

6252

</dd>

6253

<dt> Messages:</dt>

6254

<dd><table><tr><td> </td><td><pre class="example"><var>my_boulder</var>:message("orientate", <var>WEST</var>)

6255

<var>my_boulder</var>:orientate(<var>EAST</var>)

6256

<var>my_door</var>:open()

6257

</pre></td></tr></table>

6258

<a href="#Messages">Messages</a> are a main feature of Enigma. You can send them directly to any

6259

object by the ‘<samp>message()</samp>’ method or by using any message directly as a

6260

method call itself.

6261

6262

</dd>

6263

<dt> Object Classification:</dt>

6264

<dd><table><tr><td> </td><td><pre class="example"><var>obj</var>:is("st_chess")

6265

<var>obj</var>:is("st")

6266

<var>obj</var>:is("st_chess_black")

6267

</pre></td></tr></table>

6268

You create objects by giving an <a href="#Object-Kind">Object Kind</a>. Later on you can check a

6269

given object for conformity to a given class or kind. Even though you can not

6270

create abstract kind objects like ‘<samp>st</samp>’, you can check this way if an object

6271

is a stone. Checking for special subkinds may even evaluate the current state

6272

or other attributes of an object to report its current classification.

6273

6274

</dd>

6275

</dl>

6276

6277

6278

6279

6280

6281

6282

6283

6284

6285

6286

6287

6288

6289

6290

6291

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

6292

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

6293

6294

</tr></table>

6295

6296

<h3 class="subsection">5.2.5 Group Tasks</h3>

6297

6298

For reference details see section <a href="#Group">Group</a>.

6299

6300

6301

<dt> Creating Groups:</dt>

6302

<dd>

6303

<table><tr><td> </td><td><pre class="example"><var>group</var> = no["Atrax#*"] -- a group of all matching objects

6304

-- wildcards "*","?" allowed

6305

<var>group</var> = grp(<var>obj1</var>, <var>obj2</var>, <var>obj3</var>)

6306

<var>group</var> = grp({<var>obj1</var>, <var>obj2</var>, <var>obj3</var>}) -- a group of objects set up in a table

6307

</pre></td></tr></table>

6308

6309

Requesting objects from the named object repository will result in a group of

6310

objects if you make proper usage of wildcards. Appending an asterisk ‘<samp>*</samp>’

6311

to the autonaming hash will retrieve all objects that have been set with this

6312

name suffix. But you can create a group by the ‘<samp>grp</samp>’ function, too. Simply

6313

add the desired object reference as arguments, either single or as a table.

6314

6315

</dd>

6316

<dt> Group Usage:</dt>

6317

<dd><table><tr><td> </td><td><pre class="example"><var>floor_group</var>["friction"] = <var>3.2</var> -- set attribute on all floors in the group

6318

<var>door_group</var>:message("open")

6319

<var>door_group</var>:open()

6320

<var>stone_group</var>:kill()

6321

wo[<var>floor_group</var>] = {"it_coin_m"} -- add some money on all floor positions

6322

6323

wo[<var>pos</var>] = {"st_switch", target=<var>door_group</var>, action="open"}

6324

wo[<var>pos</var>] = {"st_switch", target="<var>door</var>#*", action="close"}

6325

</pre></td></tr></table>

6326

Many object operations can be applied to groups in the same manner. The

6327

operations will be applied to all members of the group. You set attributes,

6328

send messages or call any method.

6329

6330

The world object takes a group as key, too. You can set objects of a given

6331

definition to many positions at once.

6332

6333

Another usage of groups is the application as an attribute value. E.g. you can

6334

define multiple targets by supplying a group.

6335

6336

</dd>

6337

<dt> Group Operations:</dt>

6338

<dd><table><tr><td> </td><td><pre class="example"><var>doors_lasers</var> = <var>doorgrp</var> + <var>lasergrp</var> -- join of two groups

6339

<var>lasergrp</var> = <var>doors_lasers</var> - <var>doorgrp</var> -- difference of two groups

6340

<var>common_doors</var> = <var>doorgrp1</var> * <var>doorgrp2</var> -- intersection of two groups

6341

</pre></td></tr></table>

6342

Groups offer some standard operations known from handling with sets.

6343

6344

</dd>

6345

<dt> Group Members:</dt>

6346

<dd><table><tr><td> </td><td><pre class="example"><var>count</var> = #<var>mygroup</var> -- number of objects in the group

6347

<var>obj</var> = <var>mygroup</var>[<var>5</var>] -- 5th object of the group

6348

<var>obj</var> = <var>mygroup</var>[<var>-1</var>] -- last object of the group

6349

for <var>i</var> = <var>1</var>, #<var>mygroup</var> do <var>obj</var> = <var>mygroup</var>[<var>i</var>] ... end

6350

for <var>obj</var> in <var>mygroup</var> do ... end

6351

</pre></td></tr></table>

6352

You can access the members of a group by numbered indices. The size of a group

6353

is reported by the standard Lua hash ‘<samp>#</samp>’ operator. If you need to iterate

6354

over the objects of a group you can write easily Lua for loops. You can either

6355

iterate with a counter or directly iterate the content objects.

6356

6357

</dd>

6358

<dt> Shuffled Group:</dt>

6359

<dd><table><tr><td> </td><td><pre class="example"><var>shuffled_group</var> = <var>sorted_group</var>:shuffle()

6360

<var>shuffled_group</var> = no["Atrax#*"]:shuffle()

6361

</pre></td></tr></table>

6362

Every group returns a shuffled group with the same members when receiving the

6363

message <code>"shuffle"</code>.

6364

6365

</dd>

6366

<dt> Sorted Group:</dt>

6367

<dd><table><tr><td> </td><td><pre class="example"><var>sorted_group</var> = <var>group</var>:sort("linear", po(<var>2</var>, <var>1</var>))

6368

<var>sorted_group</var> = <var>group</var>:sort("linear")

6369

<var>sorted_group</var> = <var>group</var>:sort("circular")

6370

<var>sorted_group</var> = <var>group</var>:sort()

6371

</pre></td></tr></table>

6372

Sort group objects in linear order according to given direction vector, or

6373

direction determined by the first two objects. Or order objects circular around

6374

their center. If no argument is given order objects lexically.

6375

6376

</dd>

6377

<dt> Subset Group:</dt>

6378

<dd><table><tr><td> </td><td><pre class="example"><var>sub_group</var> = <var>group</var>:sub(<var>2</var>) -- first two objects

6379

<var>sub_group</var> = <var>group</var>:sub(<var>-2</var>) -- last two objects

6380

<var>sub_group</var> = <var>group</var>:sub(<var>2</var>, <var>4</var>) -- objects from 2 to 4

6381

<var>sub_group</var> = <var>group</var>:sub(<var>2</var>, <var>-2</var>) -- two objects starting with 2

6382

</pre></td></tr></table>

6383

Build subgroup with given indices and numbers.

6384

6385

</dd>

6386

<dt> Nearest Object:</dt>

6387

<dd><table><tr><td> </td><td><pre class="example"><var>object</var> = <var>group</var>:nearest(<var>reference</var>)

6388

</pre></td></tr></table>

6389

Search object in group that is nearest to the given reference object.

6390

</dd>

6391

</dl>

6392

6393

6394

6395

6396

6397

6398

6399

6400

6401

6402

6403

6404

6405

6406

6407

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

6408

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

6409

6410

</tr></table>

6411

6412

<h3 class="subsection">5.2.6 Tiles and World Tasks</h3>

6413

6414

For reference details see section <a href="#Tile-and-Object-Declaration">Tile and Object Declaration</a>, <a href="#Tiles-Repository">Tiles Repository</a>

6415

and <a href="#World">World</a>.

6416

6417

6418

<dt> Tiles:</dt>

6419

<dd><table><tr><td> </td><td><pre class="example">ti["<var>_</var>"] = {"fl_sahara"}

6420

ti["<var>__</var>"] = {"fl_sahara"}

6421

ti["<var>..</var>"] = {"fl_sand"}

6422

ti["<var>##</var>"] = {"st_blocker"}

6423

ti["<var>switch_template</var>"] = {"st_switch"}

6424

ti["<var>..</var>"] = {"fl_abyss"} -- redefinition causes error to avoid common mistakes

6425

ti["<var>.w</var>"] = ti["<var>..</var>"] .. {"it_magicwand"}

6426

ti["<var> w</var>"] = {"fl_abyss"} .. ti({"it_magicwand"})

6427

</pre></td></tr></table>

6428

The tiles repository ‘<samp>ti</samp>’ is like a table, but specialized on storage of

6429

tile definitions. You can use any string as key. You can store the same

6430

definition twice at different keys. But you are not allowed to redefine an

6431

already set key. This is pure protection of common error situations. A

6432

definition stored in the repository can be used in other definitions that

6433

follow. Referencing a tiles repository entry at a given key like ‘<samp>ti[".."]</samp>’

6434

results in a tile value. Such tile values can be concatenated by the ‘<samp>..</samp>’

6435

operator with other tile values and anonymous tables containing object

6436

definitions. The last example is a concatenation of two prior not declared

6437

object definitions. You can not concatenate two anonymous tables. Lua forbids

6438

that. By converting any of the two tables by the ‘<samp>ti()</samp>’ to a tile value the

6439

concatenation gets valid.

6440

6441

</dd>

6442

<dt> World Initialization</dt>

6443

<dd><table><tr><td> </td><td><pre class="example"> <var>width</var>, <var>height</var> = wo(ti, "<var>__</var>", { -- second arg: default tile key that

6444

"<var>##__......</var>", -- defines the base, too - this example

6445

"<var>##..__.w__</var>", -- is 2 chars per tile/grid

6446

"<var>##.. w__..</var>"

6447

})

6448

</pre></td></tr></table>

6449

The world is initialized by the ‘<samp>wo()</samp>’ call that is explained in details

6450

at <a href="#World-Creation">World Creation</a>. In the simple form you supply

6451

the ‘<samp>ti</samp>’ handle as the first argument. The second argument is the key of

6452

the default tile definition that defines the default floor to be set if a tile

6453

does not contain another floor object. At the same time this key defines by its

6454

length the standard key length as used in the following map, too. The third

6455

argument is the map given as an anonymous table of strings. The worlds size is

6456

given by the maximum line length and the number of lines. These values are

6457

returned by the call.

6458

6459

</dd>

6460

</dl>

6461

6462

6463

6464

6465

6466

6467

6468

6469

6470

6471

6472

6473

6474

6475

6476

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

6477

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

6478

6479

</tr></table>

6480

6481

<h3 class="subsection">5.2.7 Named Positions Tasks</h3>

6482

6483

For reference details see section <a href="#PositionList">PositionList</a>.

6484

6485

6486

<dt> Named Position Usage:</dt>

6487

<dd><table><tr><td> </td><td><pre class="example"><var>obj</var>["name"] = "<var>anchor1</var>"

6488

<var>obj</var>:kill()

6489

<var>pos</var> = po["<var>anchor1</var>"]

6490

po["<var>anchor2</var>"] = <var>pos</var>

6491

</pre></td></tr></table>

6492

The position of any named object can be directly retrieved. The position is

6493

still accessible under the name, when the object gets killed. You can

6494

additionally name own positions. Note that the position of an existing object

6495

precedes a position stored under the same name.

6496

6497

</dd>

6498

<dt> Creating Position Lists:</dt>

6499

<dd><table><tr><td> </td><td><pre class="example"><var>polist</var> = po["<var>deepwater</var>#*"]

6500

<var>polist</var> = po(<var>grp</var>)

6501

</pre></td></tr></table>

6502

Requesting positions will result in a list of positions if you make proper usage

6503

of wildcards. A given object group can be converted into a position list, too.

6504

6505

</dd>

6506

<dt> Position List Usage:</dt>

6507

<dd><table><tr><td> </td><td><pre class="example">wo[<var>polist</var>] = ti["<var>x</var>"]

6508

<var>grp</var> = fl(<var>polist</var>)

6509

</pre></td></tr></table>

6510

You can use a list of positions to set tiles or to retrieve a group of floors,

6511

items, stones.

6512

6513

</dd>

6514

<dt> Position List Operations:</dt>

6515

<dd><table><tr><td> </td><td><pre class="example">wo[<var>polist</var> .. po["<var>beach</var>#*"]] = {"it_banana"}

6516

</pre></td></tr></table>

6517

Two position lists can be appended. Single positions can be appended to a given

6518

position list, too.

6519

6520

</dd>

6521

<dt> Position List Members:</dt>

6522

<dd><table><tr><td> </td><td><pre class="example">for <var>i</var> = 1, #<var>polist</var> do

6523

wo[<var>polist</var>[<var>i</var>]] = {"it_cherry"}

6524

end

6525

</pre></td></tr></table>

6526

Single positions within the list can be accessed by index. The whole list can

6527

be traversed by a simple for loop. The hash length operator reports the number

6528

of contained positions.

6529

6530

</dd>

6531

</dl>

6532

6533

6534

6535

6536

6537

6538

6539

6540

6541

6542

6543

6544

6545

6546

6547

6548

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

6549

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

6550

6551

</tr></table>

6552

6553

<h2 class="section">5.3 Advanced Lua Examples</h2>

6554

6555

Now it is time to reveal the real power of the new API. Let us look again at

6556

two real levels. Investigate the levels first by playing and then join

6557

in the line by line commentary of the source code to understand how to

6558

implement your own level ideas.

6559

6560

6561

<tr><td align="left" valign="top"><a href="#Color-Maze">5.3.1 Color Maze</a></td><td>  </td><td align="left" valign="top"> Enigma levelpack VIII, level #19

6562

</td></tr>

6563

<tr><td align="left" valign="top"><a href="#Weirdly-Wired">5.3.2 Weirdly Wired</a></td><td>  </td><td align="left" valign="top"> Enigma levelpack VIII, level #22

6564

</td></tr>

6565

</table>

6566

6567

6568

6569

6570

6571

6572

6573

6574

6575

6576

6577

6578

6579

6580

6581

6582

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

6583

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

6584

6585

</tr></table>

6586

6587

<h3 class="subsection">5.3.1 Color Maze</h3>

6588

6589

Let us view the Lua source code part. We did add a line count in the first two

6590

columns for reference purpose within this section. These line count numbers are

6591

not part of the source code itself!

6592

6593

<table><tr><td> </td><td><pre class="example">01 wo["ConserveLevel"] = <var>false</var>

6594

02 wo["FollowGrid"] = <var>false</var>

6595

03 wo["FollowMethod"] = <var>FOLLOW_SCROLL</var>

6596

04

6597

05 ti["<var> </var>"] = {"fl_fake_abyss"} .. ti({"st_lightglass"})

6598

06

6599

07 ti["<var>!</var>"] = {"fl_blueslab", "<var>blue#</var>", <var>_color</var>="<var>blue</var>"}

6600

08 ti["<var>@</var>"] = {"fl_pinkbumps", "<var>orange#</var>", <var>_color</var>="<var>orange</var>"}

6601

09 ti["<var>#</var>"] = {"fl_redslab", "<var>red#</var>", <var>_color</var>="<var>red</var>"}

6602

10 ti["<var>$</var>"] = {"fl_lawn_b", "<var>green#</var>", <var>_color</var>="<var>green</var>"}

6603

11

6604

12 ti["<var>b</var>"] = ti["<var>!</var>"] .. {"st_door", flavor="<var>d</var>", faces="<var>ns</var>", state=<var>OPEN</var>}

6605

13 ti["<var>B</var>"] = ti["<var>!</var>"] .. {"st_door", flavor="<var>d</var>", faces="<var>ew</var>", state=<var>OPEN</var>}

6606

14 ti["<var>o</var>"] = ti["<var>@</var>"] .. {"st_door", flavor="<var>d</var>", faces="<var>ns</var>", state=<var>OPEN</var>}

6607

15 ti["<var>O</var>"] = ti["<var>@</var>"] .. {"st_door", flavor="<var>d</var>", faces="<var>ew</var>", state=<var>OPEN</var>}

6608

16 ti["<var>r</var>"] = ti["<var>#</var>"] .. {"st_door", flavor="<var>d</var>", faces="<var>ns</var>", state=<var>OPEN</var>}

6609

17 ti["<var>R</var>"] = ti["<var>#</var>"] .. {"st_door", flavor="<var>d</var>", faces="<var>ew</var>", state=<var>OPEN</var>}

6610

18 ti["<var>g</var>"] = ti["<var>$</var>"] .. {"st_door", flavor="<var>d</var>", faces="<var>ns</var>", state=<var>OPEN</var>}

6611

19 ti["<var>G</var>"] = ti["<var>$</var>"] .. {"st_door", flavor="<var>d</var>", faces="<var>ew</var>", state=<var>OPEN</var>}

6612

20

6613

21 ti["<var>d</var>"] = {"it_document", text="<var>text1</var>"}

6614

22 ti["<var>5</var>"] = ti["<var>b</var>"] .. ti["<var>d</var>"]

6615

23 ti["<var>6</var>"] = ti["<var>O</var>"] .. ti["<var>d</var>"]

6616

24 ti["<var>7</var>"] = ti["<var>r</var>"] .. ti["<var>d</var>"]

6617

25 ti["<var>8</var>"] = ti["<var>G</var>"] .. ti["<var>d</var>"]

6618

26

6619

27 ti["<var>x</var>"] = {"it_sensor", invisible=<var>true</var>, target="<var>gates</var>"}

6620

28 ti["<var>*</var>"] = ti["<var>x</var>"] .. {"#ac_marble_black", "<var>me</var>"}

6621

29

6622

30 ti["<var>?</var>"] = {"st_oxyd_a"}

6623

31

6624

32 wo(ti, "<var> </var>", {

6625

33 -- | 1 1 |2 2

6626

34 -- |1 5 0 5 |0 5

6627

35 "<var> </var>",

6628

36 "<var> xO@OxR#RxO@OxB!BxR#RxB!Bx </var>", --01

6629

37 "<var> b r g g b g r </var>",

6630

38 "<var> ! # $ $ ! $ # </var>",

6631

39 "<var> b r g g b g r </var>",

6632

40 "<var> xR#RxB!BxO@OxG$GxO@OxO@Ox </var>", --05

6633

41 "<var> g g r g g b b </var>",

6634

42 "<var> $ $ # $ $ ! ! </var>",

6635

43 "<var> g g r g g b b </var>",

6636

44 "<var> xR#RxO@OxG$GxR#RxG$GxR#Rx </var>",

6637

45 "<var> g b b o b r </var>", --10

6638

46 "<var> $ ! ! @ ! # </var>",

6639

47 "<var> g b 5 o ? b r </var>", --

6640

48 "<var> xO@OxO@6*8$Gx xG$GxR#Rx </var>",

6641

49 "<var> r b 7 b ? o o </var>",

6642

50 "<var> # ! # ! @ @ </var>", --15

6643

51 "<var> r b r b o o </var>",

6644

52 "<var> xG$GxB!BxR#RxO@OxR#RxG$Gx </var>",

6645

53 "<var> g o o g g o b </var>",

6646

54 "<var> $ @ @ $ $ @ ! </var>",

6647

55 "<var> g o o g g o b </var>", --20

6648

56 "<var> xB!BxO@OxR#RxR#RxO@OxB!Bx </var>",

6649

57 "<var> o r g g b b g </var>",

6650

58 "<var> @ # $ $ ! ! $ </var>",

6651

59 "<var> o r g g b b g </var>", --

6652

60 "<var> xR#RxB!BxB!BxR#RxO@OxR#Rx </var>", --25

6653

61 "<var> </var>"} --

6654

62 -- | 1 1 |2 2

6655

63 -- |1 5 0 5 |0 5

6656

64 )

6657

65

6658

66 <var>last</var> = it(no["<var>me</var>"]) -- the last visited sensor

6659

67 <var>move</var> = <var>0</var> -- the count of link moves

6660

68 <var>sequence</var> = {} -- the sequence of the 4 colors that the user did choose

6661

69

6662

70 function <var>gates</var>(<var>value</var>, <var>sender</var>)

6663

71 if <var>last</var> ~= <var>sender</var> then

6664

72 local <var>middle</var> = <var>last</var> + (<var>sender</var> - <var>last</var>)/<var>2</var>

6665

73 local <var>color</var> = fl(<var>middle</var>)["<var>_color</var>"]

6666

74 if <var>color</var> == <var>nil</var> then return end -- someone cheated, avoid throwing an exception

6667

75 st(no[<var>color</var>.."<var>#*</var>"]):close()

6668

76 <var>sequence</var>[<var>move</var>%<var>4</var>] = <var>color</var>

6669

77 if <var>move</var> >= <var>3</var> then

6670

78 st(no[<var>sequence</var>[(<var>move</var>+<var>1</var>)%<var>4</var>].."<var>#*</var>"]):open()

6671

79 end

6672

80 <var>move</var> = <var>move</var> + <var>1</var>

6673

81 <var>last</var> = <var>sender</var>

6674

82 end

6675

83 end

6676

</pre></td></tr></table>

6677

6678

Let us concentrate on new aspects not discussed in the previous

6679

<a href="#Basic-Lua-Examples">Basic Lua Examples</a>.

6680

6681

<table><tr><td> </td><td><pre class="example">01 wo["ConserveLevel"] = <var>false</var>

6682

02 wo["FollowGrid"] = <var>false</var>

6683

03 wo["FollowMethod"] = <var>FOLLOW_SCROLL</var>

6684

</pre></td></tr></table>

6685

This level must forbid the user to resurrect a marble at the start position.

6686

At the same time the user should see the area around the marble as complete as

6687

possible. Thus the scroll mode needs to be set, too. All this is done by

6688

setting special <a href="#Global-Attributes">Global Attributes</a>.

6689

6690

<table><tr><td> </td><td><pre class="example">05 ti["<var> </var>"] = {"fl_fake_abyss"} .. ti({"st_lightglass"})

6691

32 wo(ti, "<var> </var>", {

6692

</pre></td></tr></table>

6693

The inaccessible areas are filled with a transparent glass on top of a black

6694

floor as defined in line 5. The world initialization uses this tile definition

6695

as the default tile. This is o.k. as it contains a floor definition. Additional

6696

objects like the glass stone will never be set on default usage.

6697

6698

<table><tr><td> </td><td><pre class="example">07 ti["<var>!</var>"] = {"fl_blueslab", "<var>blue#</var>", <var>_color</var>="<var>blue</var>"}

6699

08 ti["<var>@</var>"] = {"fl_pinkbumps", "<var>orange#</var>", <var>_color</var>="<var>orange</var>"}

6700

09 ti["<var>#</var>"] = {"fl_redslab", "<var>red#</var>", <var>_color</var>="<var>red</var>"}

6701

10 ti["<var>$</var>"] = {"fl_lawn_b", "<var>green#</var>", <var>_color</var>="<var>green</var>"}

6702

</pre></td></tr></table>

6703

Every floor object is autonamed for later group access purposes. Additionally

6704

every floor object sets a user attribute prefixed in its name by an underscore

6705

‘<samp>_</samp>’. This attribute stores a string that we need later on in the callback

6706

function.

6707

6708

<table><tr><td> </td><td><pre class="example">12 ti["<var>b</var>"] = ti["<var>!</var>"] .. {"st_door", flavor="<var>d</var>", faces="<var>ns</var>", state=<var>OPEN</var>}

6709

13 ti["<var>B</var>"] = ti["<var>!</var>"] .. {"st_door", flavor="<var>d</var>", faces="<var>ew</var>", state=<var>OPEN</var>}

6710

</pre></td></tr></table>

6711

The doors are set without being named, as we will target them by their position.

6712

6713

<table><tr><td> </td><td><pre class="example">27 ti["<var>x</var>"] = {"it_sensor", invisible=<var>true</var>, target="<var>gates</var>"}

6714

</pre></td></tr></table>

6715

The actors moves are detected by invisible <a href="#it_005fsensor">it_sensor</a>s that are positioned

6716

on any intersection. The target is the <a href="#Callback-Function">Callback Function</a> ‘<samp>gates</samp>’.

6717

The action can be omitted as the function name is a unique target.

6718

6719

<table><tr><td> </td><td><pre class="example">66 <var>last</var> = it(no["<var>me</var>"]) -- the last visited sensor

6720

</pre></td></tr></table>

6721

A Lua variable that stores the last sensor visited by the marble. This is

6722

initially the sensor beneath the start position of the marble. We do get the

6723

marble by name, but do store the sensor item beneath it, that is an unnamed

6724

object.

6725

6726

<table><tr><td> </td><td><pre class="example">67 <var>move</var> = <var>0</var> -- the count of link moves

6727

68 <var>sequence</var> = {} -- the sequence of the 4 colors that the user did choose

6728

</pre></td></tr></table>

6729

These are the essential variables for our algorithm. The user is free in

6730

selecting the sequence of the colored floors. We do initialize the sequence

6731

by an anonymous table that will be filled with the color names. An additional

6732

move counter will give us the current index into this table.

6733

6734

<table><tr><td> </td><td><pre class="example">70 function <var>gates</var>(<var>value</var>, <var>sender</var>)

6735

71 if <var>last</var> ~= <var>sender</var> then

6736

</pre></td></tr></table>

6737

The callback function provides the sender, the <a href="#it_005fsensor">it_sensor</a>, that caused

6738

the action. It is the current sensor. As the marble can return to the last

6739

sensor, we have to check that it is a new sensor before taking any actions.

6740

A simple object comparison suffices.

6741

6742

<table><tr><td> </td><td><pre class="example">72 local <var>middle</var> = <var>last</var> + (<var>sender</var> - <var>last</var>)/<var>2</var>

6743

73 local <var>color</var> = fl(<var>middle</var>)["<var>_color</var>"]

6744

</pre></td></tr></table>

6745

We need to know the color of the floor strip that the marble did pass. We do

6746

calculate the position of the middle of this floor strip by position calculation.

6747

We simply take the middle position between the last and the current intersection.

6748

Once we have the middle position we can get the floor object and retrieve the

6749

private user attribute with the color description.

6750

6751

<table><tr><td> </td><td><pre class="example">74 if <var>color</var> == <var>nil</var> then return end -- someone cheated, avoid throwing an exception

6752

</pre></td></tr></table>

6753

In regular play we are guaranteed to get a color value. But just in case a

6754

gamer cheats he may have moved irregular without visiting neighboring sensors.

6755

Just avoid errors. The gamer can not score anyway.

6756

6757

<table><tr><td> </td><td><pre class="example">75 st(no[<var>color</var>.."<var>#*</var>"]):close()

6758

</pre></td></tr></table>

6759

Knowing the color we want to close all doors on same colored floor strips. We

6760

did autoname the floors by matching name prefixes. Thus we can retrieve all

6761

floors of a given color by concatenating the color string with the suffix

6762

‘<samp>#*</samp>’ and requesting the named object repository. As we are interested in

6763

the doors we do request the stone above every floor. We provide a group of

6764

floors and get a group of stones. Not every floor has a door on top. That does

6765

not matter as only existing objects are added to the resulting stone group.

6766

Knowing the stones we just send them all a ‘<samp>close</samp>’ message.

6767

6768

<table><tr><td> </td><td><pre class="example">76 <var>sequence</var>[<var>move</var>%<var>4</var>] = <var>color</var>

6769

</pre></td></tr></table>

6770

We need to remember the sequence of colors. We just store the color name in

6771

the table at the index given by the move count modulo 4. Yes we could limit

6772

this statement to the first four moves. But who cares? The modulo operation

6773

is simpler than a conditional expression.

6774

6775

<table><tr><td> </td><td><pre class="example">77 if <var>move</var> >= <var>3</var> then

6776

78 st(no[<var>sequence</var>[(<var>move</var>+<var>1</var>)%<var>4</var>].."<var>#*</var>"]):open()

6777

79 end

6778

</pre></td></tr></table>

6779

On the first 3 moves we just do close doors and remember the color sequence.

6780

But starting with the 4th move we need to open the next color in sequence.

6781

We do retrieve the color string of the next color from the sequence table by

6782

a simple modulo calculation. Having the color name we do the same trick as in

6783

line 75. But this time we do send the ‘<samp>open</samp>’ messages to all affected doors.

6784

6785

6786

81 <var>last</var> = <var>sender</var>

6787

</pre></td></tr></table>

6788

Finally we just have to increase the move count and to remember the current

6789

sender as the last visited sensor.

6790

6791

That is all to code a quite complex dynamic level idea like "Color Maze".

6792

6793

6794

6795

6796

6797

6798

6799

6800

6801

6802

6803

6804

6805

6806

6807

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

6808

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

6809

6810

</tr></table>

6811

6812

<h3 class="subsection">5.3.2 Weirdly Wired</h3>

6813

You should have restarted this level several times to notice the design changes

6814

of the floor pattern and the border panel stones besides the dynamic wiring of

6815

the stones.

6816

6817

Let us view the Lua source code part. We did add a line count in the first two

6818

columns for reference purpose within this section. These line count number are

6819

not part of the source code itself!

6820

6821

6822

02 <el:dependency el:path="lib/libmath" el:id="lib/libmath" el:release="1" el:preload="true"/>

6823

03 </el:compatibility>

6824

...

6825

04 ti["<var> </var>"] = {"fl_sahara", friction = <var>3.5</var>, adhesion = <var>4.0</var>}

6826

05 ti["<var>a</var>"] = {"fl_ivory", friction = <var>3.5</var>, adhesion = <var>4.0</var>}

6827

06 ti["<var>b</var>"] = {"fl_bright", friction = <var>3.5</var>, adhesion = <var>4.0</var>}

6828

07 ti["<var>c</var>"] = {"fl_platinum", friction = <var>3.5</var>, adhesion = <var>4.0</var>}

6829

08 ti["<var>_</var>"] = {"fl_water"}

6830

09 ti["<var>@</var>"] = {"#ac_marble_black"}

6831

10 ti["<var>w</var>"] = {"st_flat_movable", "<var>wood</var>#"}

6832

11 ti["<var>t</var>"] = {"it_trigger", "<var>trigger</var>#"}

6833

12 ti["<var>d</var>"] = {"st_blocker", "<var>door</var>#"}

6834

13 ti["<var>o</var>"] = {"st_oxyd", oxydcolor = <var>OXYD_YELLOW</var>, flavor = "<var>a</var>"}

6835

14 ti["<var>O</var>"] = {"st_oxyd", oxydcolor = <var>OXYD_WHITE</var>, flavor = "<var>a</var>"}

6836

15 ti["<var>1</var>"] = {"st_panel", cluster = <var>1</var>}

6837

16 ti["<var>2</var>"] = {"st_panel", cluster = <var>2</var>}

6838

17 ti["<var>S</var>"] = {"st_switch", target = "<var>easy_mode_call</var>"}

6839

18

6840

19 <var>floors</var> = {ti["<var> </var>"], ti["<var>a</var>"], ti["<var>b</var>"], ti["<var>c</var>"]}

6841

20 <var>polynom</var> = lib.math.random_vector(<var>10</var>, <var>4</var>)

6842

21

6843

22 function <var>myresolver</var>(<var>key</var>, <var>x</var>, <var>y</var>)

6844

23 if <var>key</var> == "<var> </var>" then

6845

24 return <var>floors</var>[lib.math.cubic_polynomial(<var>polynom</var>, <var>x</var>, <var>y</var>) % (#<var>floors</var>) + <var>1</var>]

6846

25 elseif (<var>key</var> == "<var>#</var>")

6847

26 or ((<var>key</var> == "<var>_</var>") and (random(<var>4</var>) == <var>1</var>))

6848

27 or ((<var>key</var> == "<var>S</var>") and wo["IsDifficult"]) then

6849

28 return ti[""..random(<var>2</var>)]

6850

29 else

6851

30 return ti[<var>key</var>]

6852

31 end

6853

32 end

6854

33

6855

34 <var>w</var>, <var>h</var> = wo(<var>myresolver</var>, "<var> </var>", {

6856

35 -- 01234567890123456789

6857

36 "<var>####################___________________</var>",

6858

37 "<var># #_____###o###_______</var>",

6859

38 "<var># w w t t #_____#d d#_______</var>",

6860

39 "<var># w w t t #___### ### ###_____</var>",

6861

40 "<var># w t #___#d d#_#d d#_____</var>",

6862

41 "<var># ##### ###_### ###___</var>",

6863

42 "<var>S w w t @ t d#___#_#d d#___</var>",

6864

43 "<var># #######_####### #___</var>",

6865

44 "<var># w t #_______O d# # o___</var>",

6866

45 "<var># w w t t #_______### ### #___</var>",

6867

46 "<var># w w t t #_________#d d#___</var>",

6868

47 "<var># #_________###O###___</var>",

6869

48 "<var>####################___________________</var>"

6870

49 })

6871

50

6872

51 <var>door_p</var> = lib.math.permutation(<var>12</var>)

6873

52 <var>wire_p</var> = lib.math.permutation(<var>12</var>)

6874

53 <var>woods</var> = no["<var>wood</var>#*"]

6875

54 <var>triggers</var> = no["<var>trigger</var>#*"]

6876

55 <var>doors</var> = no["<var>door</var>#*"]

6877

56

6878

57 for <var>j</var> = <var>1</var>, <var>12</var> do

6879

58 <var>triggers</var>[<var>j</var>].target = <var>doors</var>[<var>door_p</var>[<var>j</var>]]

6880

59 end

6881

60

6882

61 for <var>j</var> = <var>1</var>, <var>9</var> do

6883

62 wo:add({"ot_wire",

6884

63 anchor1 = <var>woods</var>[<var>wire_p</var>[<var>j</var> + <var>3</var>]],

6885

64 anchor2 = <var>woods</var>[<var>wire_p</var>[<var>j</var>%<var>3</var> + <var>1</var>]]})

6886

65 wo:add({"ot_wire", name = "<var>obsolete_wire</var>#",

6887

66 anchor1 = <var>woods</var>[<var>wire_p</var>[<var>j</var> + <var>3</var>]],

6888

67 anchor2 = <var>woods</var>[<var>wire_p</var>[<var>j</var>%<var>9</var> + <var>4</var>]]})

6889

68 end

6890

69

6891

70 function <var>easy_mode_call</var>(<var>is_on</var>, <var>sender</var>)

6892

71 if <var>is_on</var> then

6893

72 no["<var>obsolete_wire</var>#*"]:kill()

6894

73 else

6895

74 for <var>j</var> = <var>1</var>, <var>9</var> do

6896

75 wo:add({"ot_wire", name = "<var>obsolete_wire</var>#",

6897

76 anchor1 = <var>woods</var>[<var>wire_p</var>[<var>j</var> + <var>3</var>]],

6898

77 anchor2 = <var>woods</var>[<var>wire_p</var>[<var>j</var>%<var>9</var> + <var>4</var>]]})

6899

78 end

6900

79 end

6901

80 end

6902

</pre></td></tr></table>

6903

How is this versatility in design and action achieved as the last lines 69 to

6904

79 obviously deal just with the easy mode diffs? Let us analyse the lines

6905

that do the real work.

6906

6907

6908

02 <el:dependency el:path="lib/libmath" el:id="lib/libmath" el:release="1" el:preload="true"/>

6909

03 </el:compatibility>

6910

</pre></td></tr></table>

6911

We make use of some functions of the <a href="#libmath">libmath</a> library. Thus we need to

6912

preload it, besides declaration of compatibility to Enigma 1.10.

6913

6914

<table><tr><td> </td><td><pre class="example">04 ti["<var> </var>"] = {"fl_sahara", friction = <var>3.5</var>, adhesion = <var>4.0</var>}

6915

05 ti["<var>a</var>"] = {"fl_ivory", friction = <var>3.5</var>, adhesion = <var>4.0</var>}

6916

06 ti["<var>b</var>"] = {"fl_bright", friction = <var>3.5</var>, adhesion = <var>4.0</var>}

6917

07 ti["<var>c</var>"] = {"fl_platinum", friction = <var>3.5</var>, adhesion = <var>4.0</var>}

6918

</pre></td></tr></table>

6919

Four floor types that the dynamic floor is composed of. They all are unified

6920

in the ‘<samp>friction</samp>’ and ‘<samp>adhesion</samp>’ to provide smooth movement on the

6921

stylish floor.

6922

6923

<table><tr><td> </td><td><pre class="example">10 ti["<var>w</var>"] = {"st_flat_movable", "<var>wood</var>#"}

6924

11 ti["<var>t</var>"] = {"it_trigger", "<var>trigger</var>#"}

6925

12 ti["<var>d</var>"] = {"st_blocker", "<var>door</var>#"}

6926

</pre></td></tr></table>

6927

The movable stone that will be wired, the target triggers and the doors to be

6928

opened. All are autonamed for group retrieval from the named object repository.

6929

6930

<table><tr><td> </td><td><pre class="example">13 ti["<var>o</var>"] = {"st_oxyd", oxydcolor = <var>OXYD_YELLOW</var>, flavor = "<var>a</var>"}

6931

14 ti["<var>O</var>"] = {"st_oxyd", oxydcolor = <var>OXYD_WHITE</var>, flavor = "<var>a</var>"}

6932

</pre></td></tr></table>

6933

A minor design aspect: selecting two unique colors for the <a href="#st_005foxyd">st_oxyd</a>s.

6934

6935

<table><tr><td> </td><td><pre class="example">15 ti["<var>1</var>"] = {"st_panel", cluster = <var>1</var>}

6936

16 ti["<var>2</var>"] = {"st_panel", cluster = <var>2</var>}

6937

</pre></td></tr></table>

6938

The base of the prominent all time different looking <a href="#st_005fpanel">st_panel</a> border

6939

design. Two tiles with panel stones assigned to two different clusters. The

6940

engine will automatically join all neighboring stones of the same cluster to

6941

big unified blocks. Now we just need to assign these tiles to the different

6942

grid positions.

6943

6944

<table><tr><td> </td><td><pre class="example">17 ti["<var>S</var>"] = {"st_switch", target = "<var>easy_mode_call</var>"}

6945

</pre></td></tr></table>

6946

The left border switch that will just be used in easy mode. It is blocked in

6947

line 27 to not appear in the regular mode. The target is the callback function

6948

of lines 71 to 81.

6949

6950

<table><tr><td> </td><td><pre class="example">19 <var>floors</var> = {ti["<var> </var>"], ti["<var>a</var>"], ti["<var>b</var>"], ti["<var>c</var>"]}

6951

20 <var>polynom</var> = lib.math.random_vector(<var>10</var>, <var>4</var>)

6952

</pre></td></tr></table>

6953

Preparations for the floor design. The four floor tiles are stored in a table

6954

for number based index access. Ten random numbers in the range 1 to 4 are

6955

stored in a table, which we will use as polynom coefficients later on.

6956

6957

<table><tr><td> </td><td><pre class="example">22 function <var>myresolver</var>(<var>key</var>, <var>x</var>, <var>y</var>)

6958

34 <var>w</var>, <var>h</var> = wo(<var>myresolver</var>, "<var> </var>", {

6959

</pre></td></tr></table>

6960

Up to now we did look up the keys used in the map from our tiles repository

6961

‘<samp>ti</samp>’ that was the first argument of the world initialization call. But

6962

now we use a <a href="#Custom-Resolver">Custom Resolver</a>.

6963

The function starting in line 22 is called on every tile to be resolved. It has

6964

the task of delivering the appropriate tile.

6965

6966

<table><tr><td> </td><td><pre class="example">23 if <var>key</var> == "<var> </var>" then

6967

24 return <var>floors</var>[lib.math.cubic_polynomial(<var>polynom</var>, <var>x</var>, <var>y</var>) % (#<var>floors</var>) + <var>1</var>]

6968

</pre></td></tr></table>

6969

These two lines generate the always changing floor design. For every map key

6970

‘<samp> </samp>’ we calculate the cubic polynomial that is randomized due to the

6971

coefficients. The resulting number is limited to the number of our four floors.

6972

This number is taken as the index into our ‘<samp>floors</samp>’ table and the resulting

6973

tile definition is returned.

6974

6975

<table><tr><td> </td><td><pre class="example">25 elseif (<var>key</var> == "<var>#</var>")

6976

26 or ((<var>key</var> == "<var>_</var>") and (random(<var>4</var>) == <var>1</var>))

6977

27 or ((<var>key</var> == "<var>S</var>") and wo["IsDifficult"]) then

6978

28 return ti[""..random(<var>2</var>)]

6979

</pre></td></tr></table>

6980

And now we cluster the border panels. First we need to decide where to put

6981

panels at all. The positions marked ‘<samp>#</samp>’ in the map are for sure.

6982

Additionally we choose randomly every 4th ‘<samp>_</samp>’ position to be a panel

6983

instead of being a water floor. Finally we replace just in difficult mode

6984

the switch marked as ‘<samp>S</samp>’ by a panel stone. Now we need to assign to this

6985

grid position one of the two panel cluster tiles. We simply generate a random

6986

number out of 1 and 2. But we do need a string as the tiles key. We force Lua

6987

to convert the number to string by concatenating an empty string ‘<samp>""</samp>’ with

6988

the random number. Choosing the right panel variants to build up closed clusters

6989

is done by the engine.

6990

6991

<table><tr><td> </td><td><pre class="example">29 else

6992

30 return ti[<var>key</var>]

6993

</pre></td></tr></table>

6994

Finally for all other keys that need no special treatment we just take the

6995

tile definition as stored in the tiles repository.

6996

6997

<table><tr><td> </td><td><pre class="example">34 <var>w</var>, <var>h</var> = wo(<var>myresolver</var>, "<var> </var>", {

6998

35 -- 01234567890123456789

6999

36 "<var>####################___________________</var>",

7000

37 "<var># #_____###o###_______</var>",

7001

38 "<var># w w t t #_____#d d#_______</var>",

7002

39 "<var># w w t t #___### ### ###_____</var>",

7003

...

7004

</pre></td></tr></table>

7005

The map uses the keys as interpreted by the custom resolver. Thus all mandatory

7006

panel stones are marked by ‘<samp>#</samp>’ and all may be water by ‘<samp>_</samp>’. All spaces

7007

‘<samp> </samp>’ do not stand for the sahara floor definition in the tiles repository,

7008

but are floor positions for our design floor set up in the custom resolver.

7009

Note that even the ‘<samp>w</samp>’ marked tiles will set a design floor, as the

7010

default floor is ‘<samp> </samp>’, too.

7011

7012

<table><tr><td> </td><td><pre class="example">51 <var>door_p</var> = lib.math.permutation(<var>12</var>)

7013

52 <var>wire_p</var> = lib.math.permutation(<var>12</var>)

7014

</pre></td></tr></table>

7015

Now let us shuffle the trigger/door assignment and the wire distribution. We

7016

do this by permuting 12 index numbers to be used for door and wire access.

7017

7018

<table><tr><td> </td><td><pre class="example">53 <var>woods</var> = no["<var>wood</var>#*"]

7019

54 <var>triggers</var> = no["<var>trigger</var>#*"]

7020

55 <var>doors</var> = no["<var>door</var>#*"]

7021

</pre></td></tr></table>

7022

Get the groups of movable stones, triggers and doors. It is essential to do this

7023

once and to store the resulting groups as we want to index the group members.

7024

Repeated access to the named object repository does not guarantee a stable

7025

sorting of the result groups. Thus we operate on the stable once retrieved

7026

and stored groups.

7027

7028

<table><tr><td> </td><td><pre class="example">57 for <var>j</var> = <var>1</var>, <var>12</var> do

7029

58 <var>triggers</var>[<var>j</var>].target = <var>doors</var>[<var>door_p</var>[<var>j</var>]]

7030

59 end

7031

</pre></td></tr></table>

7032

A random assignment of the triggers to the doors. Every triggers gets a random

7033

indexed member of the door group as target. Note the alternative attribute

7034

member access on the trigger. Instead of embracing the attributes name in

7035

square brackets and quoting the string constant as ‘<samp>["target"]</samp>’ the

7036

author did prefer to write ‘<samp>.target</samp>’. That is a legal Lua alternative

7037

statement as long as the attribute’s name is a legal Lua name (see <a href="#Caveats">Caveats</a>).

7038

7039

<table><tr><td> </td><td><pre class="example">61 for <var>j</var> = <var>1</var>, <var>9</var> do

7040

62 wo:add({"ot_wire",

7041

63 anchor1 = <var>woods</var>[<var>wire_p</var>[<var>j</var> + <var>3</var>]],

7042

64 anchor2 = <var>woods</var>[<var>wire_p</var>[<var>j</var>%<var>3</var> + <var>1</var>]]})

7043

</pre></td></tr></table>

7044

Finally we need to add the <a href="#ot_005fwire">ot_wire</a> between our movable stones. This can

7045

not be done within the map. We need to use the <a href="#World">World</a> method

7046

‘<samp>wo:add()</samp>’, which takes the two connected stones as two anchor attributes.

7047

We select the first 3 stones of our wood group as stones to be connected with

7048

3 other stones of the indices 4 to 12. Thus we take in every loop as the first

7049

anchor one of the stones 4 to 12 and connect it to one of the first 3 stones by

7050

a simple modulo operation. The first three stones now have three wires and are

7051

finished. The last 9 stones have just one wire.

7052

7053

<table><tr><td> </td><td><pre class="example">65 wo:add({"ot_wire", name = "<var>obsolete_wire</var>#",

7054

66 anchor1 = <var>woods</var>[<var>wire_p</var>[<var>j</var> + <var>3</var>]],

7055

67 anchor2 = <var>woods</var>[<var>wire_p</var>[<var>j</var>%<var>9</var> + <var>4</var>]]})

7056

68 end

7057

</pre></td></tr></table>

7058

Now we wire these remaining 9 stones in sequence, in a closed circle. That gives

7059

each stone 2 additional wires. We do this by connecting each of the stones 4 to

7060

11 with its successor and finally connecting stone 12 to stone 4, what is done

7061

by the modulo operation. This completes the level for the regular mode.

7062

As preparation for the easy mode we do autoname these additional wires.

7063

7064

<table><tr><td> </td><td><pre class="example">71 function <var>easy_mode_call</var>(<var>is_on</var>, <var>sender</var>)

7065

72 if <var>is_on</var> then

7066

73 no["<var>obsolete_wire</var>#*"]:kill()

7067

</pre></td></tr></table>

7068

Just for the easy mode we added a switch to remove and recreate the additional

7069

wires. As we named these obsolete wires we can simply kill all of them in a

7070

single call by applying the ‘<samp>kill()</samp>’ method to the group of these wires.

7071

7072

<table><tr><td> </td><td><pre class="example">73 else

7073

74 for <var>j</var> = <var>1</var>, <var>9</var> do

7074

75 wo:add({"ot_wire", name = "<var>obsolete_wire</var>#",

7075

76 anchor1 = <var>woods</var>[<var>wire_p</var>[<var>j</var> + <var>3</var>]],

7076

77 anchor2 = <var>woods</var>[<var>wire_p</var>[<var>j</var>%<var>9</var> + <var>4</var>]]})

7077

78 end

7078

79 end

7079

</pre></td></tr></table>

7080

When the user switches off again, the wires should be recreated. That is done

7081

by the same code as lines 65 to 68. Note that is essential that we stored and

7082

kept the used wire permutation in the variable ‘<samp>wire_p</samp>’.

7083

7084

7085

7086

7087

7088

7089

7090

7091

7092

7093

7094

7095

7096

7097

7098

7099

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

7100

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

7101

7102

</tr></table>

7103

7104

<h2 class="section">5.4 Introduction to Datatypes</h2>

7105

7106

Before describing the datatypes in detail let us look at the used common

7107

concepts and conventions.

7108

7109

7110

<tr><td align="left" valign="top"><a href="#Syntax-and-Conventions">5.4.1 Syntax and Conventions</a></td><td>  </td><td align="left" valign="top"> Abbreviations in syntax descriptions

7111

</td></tr>

7112

<tr><td align="left" valign="top"><a href="#Value-and-Reference">5.4.2 Value and Reference</a></td><td>  </td><td align="left" valign="top"> Basic differences of datatypes

7113

</td></tr>

7114

<tr><td align="left" valign="top"><a href="#Polymorphism-and-Overloading">5.4.3 Polymorphism and Overloading</a></td><td>  </td><td align="left" valign="top"> Methods of Object Orientation

7115

</td></tr>

7116

<tr><td align="left" valign="top"><a href="#Pseudo-Datatypes">5.4.4 Pseudo Datatypes</a></td><td>  </td><td align="left" valign="top"> Reinterpretation of datatypes

7117

</td></tr>

7118

</table>

7119

7120

7121

7122

7123

7124

7125

7126

7127

7128

7129

7130

7131

7132

7133

7134

7135

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

7136

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

7137

7138

</tr></table>

7139

7140

<h3 class="subsection">5.4.1 Syntax and Conventions</h3>

7141

7142

In the following subchapters we will describe the datatypes, their operators

7143

and methods, and global functions in detail. We need some syntax and

7144

conventions for an efficient description.

7145

7146

The following short names, and those derived by appending a number, do always

7147

represent a value of the corresponding type:

7148

<ul>

7149

<li> pos - <a href="#Position">Position</a>

7150

</li><li> obj - <a href="#Object">Object</a>

7151

</li><li> polist - <a href="#PositionList">PositionList</a>

7152

</li><li> group - <a href="#Group">Group</a>

7153

</li><li> cpos - constant position, a table with two numbers like {2, 3}

7154

</li></ul>

7155

7156

On syntax descriptions of datatype operators or methods we need to list allowed

7157

argument types. Often several types are possible and you are allowed to choose

7158

any of a list. In these cases we enlist the types enclosed by ‘<samp><</samp>’ and

7159

‘<samp>></samp>’ and separated by ‘<samp>|</samp>’. These characters are not part of the

7160

operator or method itself and should thus not be typed into the level code. Note

7161

that we keep square braces ‘<samp>[</samp>’, ‘<samp>]</samp>’ and curly braces ‘<samp>{</samp>’,

7162

‘<samp>}</samp>’ as literal Lua symbols. When these braces appear in the syntax you

7163

need to type them in the code. E.g. the following syntax rule:

7164

7165

<table><tr><td> </td><td><pre class="example">result = <var>pos</var> + <<var>pos</var> | <var>obj</var> | <var>cpos</var> | <var>polist</var>>

7166

</pre></td></tr></table>

7167

7168

allows you to write any of the following lines in your level

7169

7170

<table><tr><td> </td><td><pre class="example"><var>result</var> = <var>pos</var> + <var>pos</var>

7171

<var>result</var> = <var>pos</var> + <var>obj</var>

7172

<var>result</var> = <var>pos</var> + <var>cpos</var>

7173

<var>result</var> = <var>pos</var> + <var>polist</var>

7174

</pre></td></tr></table>

7175

7176

But a syntax rule like

7177

7178

<table><tr><td> </td><td><pre class="example">x = pos["x"]

7179

</pre></td></tr></table>

7180

7181

requires the Lua square brackets to be coded literally. Of course you are

7182

still free to name your position variable and the resulting value variable

7183

whatever you like.

7184

7185

7186

7187

7188

7189

7190

7191

7192

7193

7194

7195

7196

7197

7198

7199

7200

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

7201

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

7202

7203

</tr></table>

7204

7205

<h3 class="subsection">5.4.2 Value and Reference</h3>

7206

7207

Another most important aspect of Lua data types is the difference between

7208

values and references. Values are numbers, booleans like ‘<samp>true</samp>’ and

7209

‘<samp>false</samp>’, strings and ‘<samp>nil</samp>’. The only reference data type is the Lua

7210

table.

7211

7212

Values are always constant. They can never be modified. You assign a value to

7213

a variable. On calculations you may assign another value to the same variable.

7214

But the original value does never get modified. That should be obvious if you

7215

think of values like ‘<samp>true</samp>’ or numbers like ‘<samp>7</samp>’. But it is even true

7216

for strings like <code>"hello"</code>. When you append two strings you get a new

7217

string. But the components themselves do not change. All "string modifying"

7218

methods do return a new string with the resulting value. Thus a variable

7219

containing the value of the original string still contains the unmodified value.

7220

7221

Tables are of a totally opposite nature. They represent data containers. In Lua

7222

you are just handling references to these containers. When you add or change

7223

a value within the container the table reference remains unmodified but the table

7224

contents changes. Thus two variable containing both references to the same

7225

table will afterwards both reference the same modified table.

7226

7227

We will denote for every new data type the character of being a value or a

7228

reference. If you are unfamiliar to the resulting effects you may want to read

7229

the appendix about <a href="#Caveats">Caveats</a>.

7230

7231

7232

7233

7234

7235

7236

7237

7238

7239

7240

7241

7242

7243

7244

7245

7246

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

7247

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

7248

7249

</tr></table>

7250

7251

<h3 class="subsection">5.4.3 Polymorphism and Overloading</h3>

7252

7253

7254

You may have noticed that in many operations you can use an <a href="#Object">Object</a> as

7255

a <a href="#Position">Position</a>. This is due to the fact that objects support most of the

7256

position features as well. Objects are no positions, but they do speak the

7257

same language. This feature is called ‘<samp>polymorphism</samp>’ and helps you to

7258

simplify your code significantly. In the following subchapters you should

7259

carefully look at the syntax to understand which types of arguments do fit in

7260

seamlessly.

7261

7262

7263

The number of usable operators is limited by Lua. Thus an addition of two data

7264

by the ‘<samp>+</samp>’ operator causes different actions depending on the involved data

7265

themselves. An addition of two positions results in a vectorial addition. But

7266

the addition of two groups results in a join of the groups. This reuse of a

7267

single operator is called ‘<samp>overloading</samp>’.

7268

7269

Overloading combined with polymorphism can cause situations that are ambiguous

7270

by design. E.g. we decided to allow the addition of a position with an object

7271

resulting in the vectorial addition of the object’s position to the first one.

7272

At the same time we want to be able to join an object with an existing group

7273

by usage of the ‘<samp>+</samp>’ operator. But what should be the result of an addition

7274

of two objects? The vectorial addition of their positions, or the join of both

7275

objects in a new group? Either makes sense and would be useful. In this case

7276

we decided for the first possibility as the minus operation as the vectorial

7277

difference between two objects is a very important feature. Anyway you can

7278

always force the operation of your choice to be applied by transforming one

7279

object either into a position or a group. Please read carefully the given

7280

syntax rules for a clear understanding of the results.

7281

7282

7283

7284

7285

7286

7287

7288

7289

7290

7291

7292

7293

7294

7295

7296

7297

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

7298

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

7299

7300

</tr></table>

7301

7302

<h3 class="subsection">5.4.4 Pseudo Datatypes</h3>

7303

7304

Even though we introduce just the ten additional fundamental datatypes as

7305

described in the following subchapters, the API does additionally differ

7306

the same datatype according to its usage. E.g. a standard Lua number is used to

7307

describe the <a href="#state">state</a> of an object. Just in rare occurrences the state will

7308

reflect a real number like the state of <a href="#ot_005fcounter">ot_counter</a>. For most objects

7309

the state will just be one of a given set of allowed values, which happen to

7310

be described by numbers by the API. Thus we speak of a pseudo datatype

7311

in the case of <a href="#state">state</a> values.

7312

7313

The API provides <a href="#Common-Constants">Common Constants</a> for all pseudo datatypes, all written in

7314

upper case letters only. You should use exclusively these constants and never

7315

their equivalent basic number or other type values. The usage of the constants

7316

makes the level code readable and upward compatible if we ever should have the

7317

need of changing the assigned values or transforming the pseudo datatype to

7318

another datatype.

7319

7320

There is one abstract datatype that needs to be mentioned, as it uses two

7321

different pseudo datatypes at the same time. This special case is the datatype

7322

used to describe the ‘<samp>direction</samp>’ or ‘<samp>orientation</samp>’. Both are

7323

essentially the same. But we speak of ‘<samp>orientation</samp>’ if we are just

7324

interested in enlisting the main directions by number values for the purpose of

7325

identification. The constant values are given as <a href="#orientations">orientations</a>.

7326

7327

Sometimes you need values for calculation of position offsets. In this case we

7328

speak of a ‘<samp>direction</samp>’ and use <a href="#Position">Position</a> values as offset vectors.

7329

The most common values are given as constants as listed in subchapter

7330

<a href="#direction-offsets">direction offsets</a>. Note that our ‘<samp>direction</samp>’ values have no need of

7331

being normalized to the length of 1.

7332

7333

A given ‘<samp>orientation</samp>’ can be transformed into a ‘<samp>direction</samp>’ value by

7334

the conversion table <a href="#ORI2DIR">ORI2DIR</a>.

7335

7336

7337

7338

7339

7340

7341

7342

7343

7344

7345

7346

7347

7348

7349

7350

7351

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

7352

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

7353

7354

</tr></table>

7355

7356

<h2 class="section">5.5 Position</h2>

7357

7358

A position is a Lua userdata type introduced by Enigma to handle world positions

7359

as introduced in <a href="#World_0027s-Shape-and-Coordinates">World’s Shape and Coordinates</a>. A position is a value

7360

and thus constant. Once a position is created it can not be modified anymore.

7361

But you can calculate with positions by usage of operators. When you add two

7362

position values you receive the resulting position as a new value.

7363

7364

In contrast to <a href="#Object">Object</a>s positions have an unlimited lifetime and will never

7365

cease to exist. Thus you can store position values in global variables and

7366

keep them as long as you need. The values are constant and will not change even

7367

if the objects from which they have been derived have meanwhile moved to another

7368

grid or even been killed.

7369

7370

Position values are not limited to valid world coordinates. Both coordinates

7371

can take every positive or negative number and zero, too. Thus you can calculate

7372

with positions and use them to express offsets between two other positions.

7373

7374

Positions are created by the <a href="#Positions-Repository">Positions Repository</a> singleton handle,

7375

that allows you to convert coordinates, objects, position constants into

7376

positions. The handle allows you to retrieve existing named positions, too.

7377

Furtheron positions are implicitly created as return values of many operations.

7378

7379

For task driven samples see section <a href="#Position-Tasks">Position Tasks</a>.

7380

7381

Let us look at the supported operators:

7382

7383

7384

<tr><td align="left" valign="top"><a href="#Position-Addition-and-Subtraction">5.5.1 Position Addition and Subtraction</a></td><td>  </td><td align="left" valign="top"> Operators ‘<samp>+</samp>’ and ‘<samp>-</samp>’

7385

</td></tr>

7386

<tr><td align="left" valign="top"><a href="#Position-Multiplication-and-Division">5.5.2 Position Multiplication and Division</a></td><td>  </td><td align="left" valign="top"> Operators ‘<samp>*</samp>’ and ‘<samp>/</samp>’

7387

</td></tr>

7388

<tr><td align="left" valign="top"><a href="#Position-Sign">5.5.3 Position Sign</a></td><td>  </td><td align="left" valign="top"> Unary Operator ‘<samp>-</samp>’

7389

</td></tr>

7390

<tr><td align="left" valign="top"><a href="#Position-Center">5.5.4 Position Center</a></td><td>  </td><td align="left" valign="top"> Operator ‘<samp>#</samp>’

7391

</td></tr>

7392

<tr><td align="left" valign="top"><a href="#Position-Comparison">5.5.5 Position Comparison</a></td><td>  </td><td align="left" valign="top"> Equality ‘<samp>==</samp>’ and Inequality ‘<samp>~=</samp>’

7393

</td></tr>

7394

<tr><td align="left" valign="top"><a href="#Position-Concatenation">5.5.6 Position Concatenation</a></td><td>  </td><td align="left" valign="top"> Operator ‘<samp>..</samp>’

7395

</td></tr>

7396

<tr><td align="left" valign="top"><a href="#Position-Coordinate-Access">5.5.7 Position Coordinate Access</a></td><td>  </td><td align="left" valign="top"> Index Operators

7397

</td></tr>

7398

<tr><td align="left" valign="top"><a href="#Position-Grid-Rounding">5.5.8 Position Grid Rounding</a></td><td>  </td><td align="left" valign="top"> Method ‘<samp>grid()</samp>’

7399

</td></tr>

7400

<tr><td align="left" valign="top"><a href="#Position-Existence">5.5.9 Position Existence</a></td><td>  </td><td align="left" valign="top"> Method ‘<samp>exists()</samp>’

7401

</td></tr>

7402

</table>

7403

7404

7405

7406

7407

7408

7409

7410

7411

7412

7413

7414

7415

7416

7417

7418

7419

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

7420

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

7421

7422

</tr></table>

7423

7424

<h3 class="subsection">5.5.1 Position Addition and Subtraction</h3>

7425

7426

7427

<dt> Syntax:</dt>

7428

<dd>result = pos <+|-> <pos | obj | cpos | polist>

7429

7430

result = <pos | obj | cpos | polist> <+|-> pos

7431

7432

</dd>

7433

<dt> Details:</dt>

7434

<dd>When a position is added to, or subtracted from another position or data

7435

convertible to a position the result is the position value representing the

7436

vectorial addition or difference of both arguments.

7437

7438

If a position is added to, or subtracted from a position list a new list is created

7439

with the positions representing the sum or difference of the position with every

7440

member of the supplied position list.

7441

7442

</dd>

7443

<dt> Syntax Samples:</dt>

7444

<dd><table><tr><td> </td><td><pre class="example"><var>newpos</var> = po(<var>3</var>, <var>4</var>) + {<var>1</var>, <var>2</var>} -- = po(4, 6)

7445

<var>newpos</var> = <var>myobject</var> - po(<var>1</var>, <var>5</var>)

7446

<var>newpolist</var> = po(<var>2</var>, <var>3</var>) + <var>NEIGHBORS_4</var> -- po(1, 3) .. po(2, 4) .. po(3, 3) .. po(2, 2)

7447

<var>newpolist</var> = po["<var>myfloor</var>#*"] - po(<var>3</var>, <var>0</var>)

7448

</pre></td></tr></table>

7449

</dd>

7450

</dl>

7451

7452

7453

7454

7455

7456

7457

7458

7459

7460

7461

7462

7463

7464

7465

7466

7467

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

7468

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

7469

7470

</tr></table>

7471

7472

<h3 class="subsection">5.5.2 Position Multiplication and Division</h3>

7473

7474

7475

<dt> Syntax:</dt>

7476

<dd>result = pos <*|/> number

7477

7478

result = number * pos

7479

7480

</dd>

7481

<dt> Details:</dt>

7482

<dd>A scalar multiplication or division of a position vector. A position value

7483

with both coordinate values multiplicated or divided by the given number

7484

is returned.

7485

7486

</dd>

7487

<dt> Syntax Samples:</dt>

7488

<dd><table><tr><td> </td><td><pre class="example"><var>newpos</var> = <var>3</var> * po(<var>3</var>, <var>4</var>) -- = po(9, 12)

7489

<var>newpos</var> = po(<var>2</var>, <var>3</var>) / <var>2</var> -- = po(1, 1.5)

7490

</pre></td></tr></table>

7491

</dd>

7492

</dl>

7493

7494

7495

7496

7497

7498

7499

7500

7501

7502

7503

7504

7505

7506

7507

7508

7509

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

7510

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

7511

7512

</tr></table>

7513

7514

<h3 class="subsection">5.5.3 Position Sign</h3>

7515

7516

7517

<dt> Syntax:</dt>

7518

<dd>result = -pos

7519

7520

</dd>

7521

<dt> Details:</dt>

7522

<dd>An unary scalar multiplication of a position vector with ‘<samp>-1</samp>’. A new

7523

position value with both coordinate values multiplicated by ‘<samp>-1</samp>’ is returned.

7524

7525

</dd>

7526

<dt> Syntax Samples:</dt>

7527

<dd><table><tr><td> </td><td><pre class="example"><var>newpos</var> = -po(<var>3</var>, <var>4</var>) -- = po(-3, -4)

7528

</pre></td></tr></table>

7529

</dd>

7530

</dl>

7531

7532

7533

7534

7535

7536

7537

7538

7539

7540

7541

7542

7543

7544

7545

7546

7547

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

7548

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

7549

7550

</tr></table>

7551

7552

<h3 class="subsection">5.5.4 Position Center</h3>

7553

7554

7555

<dt> Syntax:</dt>

7556

<dd>result = #pos

7557

7558

</dd>

7559

<dt> Details:</dt>

7560

<dd>A rounding of a position vector to the center of the grid. A new position value

7561

with coordinates of the center of the containing grid position is returned.

7562

7563

</dd>

7564

<dt> Syntax Samples:</dt>

7565

<dd><table><tr><td> </td><td><pre class="example"><var>newpos</var> = #po(<var>3</var>, <var>4</var>) -- = po(3.5, 4.5)

7566

</pre></td></tr></table>

7567

</dd>

7568

</dl>

7569

7570

7571

7572

7573

7574

7575

7576

7577

7578

7579

7580

7581

7582

7583

7584

7585

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

7586

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

7587

7588

</tr></table>

7589

7590

<h3 class="subsection">5.5.5 Position Comparison</h3>

7591

7592

Equality and Inequality.

7593

7594

7595

<dt> Syntax:</dt>

7596

<dd>result = pos1 <==|~=> pos2

7597

7598

</dd>

7599

<dt> Details:</dt>

7600

<dd>A comparison of two position values. Two position values are equal if both

7601

coordinates are equal. Otherwise they are unequal. If you want to know whether

7602

two positions point to the same grid, you may want to round both position prior

7603

comparison. You can round either to the center or to the grid by usage of

7604

the position operator ‘<samp>#</samp>’ or the method ‘<samp>grid()</samp>’.

7605

7606

</dd>

7607

<dt> Syntax Samples:</dt>

7608

<dd><table><tr><td> </td><td><pre class="example"><var>bool</var> = po(<var>3</var>, <var>4</var>) == po({<var>3</var>, <var>4</var>}) -- = true

7609

<var>bool</var> = po(<var>3</var>, <var>4</var>) == po(<var>4</var>, <var>3</var>) -- = false

7610

<var>bool</var> = po(<var>3</var>, <var>4</var>) ~= po(<var>4</var>, <var>3</var>) -- = true

7611

</pre></td></tr></table>

7612

</dd>

7613

</dl>

7614

7615

7616

7617

7618

7619

7620

7621

7622

7623

7624

7625

7626

7627

7628

7629

7630

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

7631

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

7632

7633

</tr></table>

7634

7635

<h3 class="subsection">5.5.6 Position Concatenation</h3>

7636

7637

7638

<dt> Syntax:</dt>

7639

<dd>result = pos1 .. <pos2 | polist>

7640

7641

result = <pos1 | polist> .. pos2

7642

7643

</dd>

7644

<dt> Details:</dt>

7645

<dd>Concatenates two positions or a position with an existing <a href="#PositionList">PositionList</a> to a

7646

new PositionList containing all positions in the given order. Note that this

7647

operation is associative, that means it does not matter if you use braces in

7648

multiple concatenations or not.

7649

7650

</dd>

7651

<dt> Syntax Samples:</dt>

7652

<dd><table><tr><td> </td><td><pre class="example"><var>newpolist</var> = po(<var>3</var>, <var>4</var>) .. po(<var>4</var>, <var>4</var>)

7653

</pre></td></tr></table>

7654

</dd>

7655

</dl>

7656

7657

7658

7659

7660

7661

7662

7663

7664

7665

7666

7667

7668

7669

7670

7671

7672

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

7673

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

7674

7675

</tr></table>

7676

7677

<h3 class="subsection">5.5.7 Position Coordinate Access</h3>

7678

7679

7680

<dt> Syntax:</dt>

7681

<dd>result = pos["x"]

7682

7683

result = pos["y"]

7684

7685

result1, result2 = pos:xy()

7686

7687

</dd>

7688

<dt> Details:</dt>

7689

<dd>The single coordinates of a position can be read anytime. You can retrieve

7690

single coordinates by Lua square bracket index access. Of course you can use

7691

the Lua alternative dot index access syntax, too (see examples). If you want

7692

to evaluate both coordinates, you can make use of the method ‘<samp>xy()</samp>’, that

7693

returns both numbers at once in a Lua multiple assignment.

7694

7695

</dd>

7696

<dt> Syntax Samples:</dt>

7697

<dd><table><tr><td> </td><td><pre class="example"><var>number</var> = po(<var>3</var>, <var>4</var>)["x"] -- = 3

7698

<var>number</var> = po(<var>3</var>, <var>4</var>).x -- = 3

7699

<var>number</var> = po(<var>3</var>, <var>4</var>)["y"] -- = 4

7700

<var>number</var> = po(<var>3</var>, <var>4</var>).y -- = 4

7701

<var>number1</var>, <var>number2</var> = po(<var>3</var>, <var>4</var>):xy() -- = 3, 4

7702

</pre></td></tr></table>

7703

</dd>

7704

</dl>

7705

7706

7707

7708

7709

7710

7711

7712

7713

7714

7715

7716

7717

7718

7719

7720

7721

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

7722

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

7723

7724

</tr></table>

7725

7726

<h3 class="subsection">5.5.8 Position Grid Rounding</h3>

7727

7728

7729

<dt> Syntax:</dt>

7730

<dd>result = pos:grid()

7731

7732

</dd>

7733

<dt> Details:</dt>

7734

<dd>Returns a new position value that points to the upper left corner of the grid

7735

that contains the position itself.

7736

7737

</dd>

7738

<dt> Syntax Samples:</dt>

7739

<dd><table><tr><td> </td><td><pre class="example"><var>newpos</var> = po(<var>3.2</var>, <var>4.7</var>):grid() -- = 3, 4

7740

<var>newpos</var> = po(<var>-2.4</var>, <var>-5.0</var>):grid() -- = -3, -5

7741

</pre></td></tr></table>

7742

</dd>

7743

</dl>

7744

7745

7746

7747

7748

7749

7750

7751

7752

7753

7754

7755

7756

7757

7758

7759

7760

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

7761

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

7762

7763

</tr></table>

7764

7765

<h3 class="subsection">5.5.9 Position Existence</h3>

7766

7767

7768

<dt> Syntax:</dt>

7769

<dd>result = pos:exists()

7770

7771

</dd>

7772

<dt> Details:</dt>

7773

<dd>Checks if the position is part of the world and returns ‘<samp>true</samp>’ if it is

7774

contained. Otherwise ‘<samp>false</samp>’ is returned.

7775

7776

Note that the <a href="#Object">Object</a>s ‘<samp>exists</samp>’ method reports the existence of the

7777

object. Evaluation of ‘<samp>po(obj):exists()</samp>’ may result in ‘<samp>false</samp>’ for

7778

existing objects. E.g. this result occurs for <a href="#Item-Objects">Item Objects</a> currently

7779

being part of a player’s inventory. The item exists, but is not part of the

7780

world. But items contained in a bag placed in the world will report the same

7781

position as the bag.

7782

7783

</dd>

7784

<dt> Syntax Samples:</dt>

7785

<dd><table><tr><td> </td><td><pre class="example"><var>boolean</var> = po(<var>3.2</var>, <var>4.7</var>):exists()

7786

</pre></td></tr></table>

7787

</dd>

7788

</dl>

7789

7790

7791

7792

7793

7794

7795

7796

7797

7798

7799

7800

7801

7802

7803

7804

7805

7806

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

7807

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

7808

7809

</tr></table>

7810

7811

<h2 class="section">5.6 Object</h2>

7812

7813

This datatype handles all world participating objects as described in

7814

<a href="#Object-Layers">Object Layers</a>. When you request an object you get a reference to this

7815

object and not the object itself. You can modify the object, but the object

7816

can be modified by user actions, too. Deleting your reference by assigning

7817

another value to your variable does not delete the object itself.

7818

7819

On the other hand an object can cease to exist due to user actions while you

7820

still have a reference assigned to a Lua variable. Of course this reference

7821

gets invalid when the referenced object is deleted. But such an invalid

7822

reference, which we call a ‘<samp>NULL</samp>’ reference, is no longer fatal with the

7823

new API. Any write accesses on such references are simply ignored. Thus you can

7824

send messages to object references independently of their validity. Just on

7825

read accesses you may want to prior check the existence of an object as you

7826

would get ‘<samp>nil</samp>’ values on access of ‘<samp>NULL</samp>’ references.

7827

7828

Objects take attributes that you access by Lua index methods. Additional to

7829

the object specific attributes you are free to store your own custom

7830

attributes on any object. Custom attributes are any indices starting with an

7831

underscore ‘<samp>_</samp>’ as prefix to their name.

7832

7833

The real world objects are created by assigning a tile declaration to

7834

a <a href="#World">World</a> position. You retrieve a corresponding object reference either

7835

by the <a href="#NamedObjects">NamedObjects</a> repository, by <a href="#Functions">Functions</a> or other methods that

7836

return single object references.

7837

7838

Objects provide most methods of a <a href="#Position">Position</a> and can in most cases be

7839

directly used as a position without explicit conversion. Just special methods

7840

like existence differ on both datatypes. Of course all objects placed in the

7841

world are limited to positions within the world. But be aware that portable

7842

<a href="#Item-Objects">Item Objects</a> can well be part of a player’s inventory and thus report a

7843

position outside of the world. Actors will always report positions rounded to

7844

the containing grid. This feature is legacy. As Lua code is anyway inappropriate

7845

to handle actor movements we maintained this rounding feature.

7846

7847

Objects support standard set operators of <a href="#Group">Group</a>s, too, as long as one

7848

operand is a group and the other an object.

7849

7850

For task driven samples see section <a href="#Object-Tasks">Object Tasks</a> and <a href="#Attribute-Tasks">Attribute Tasks</a>.

7851

7852

7853

<tr><td align="left" valign="top"><a href="#Object-Attribute-Access">5.6.1 Object Attribute Access</a></td><td>  </td><td align="left" valign="top"> Index Operators ‘<samp>[]</samp>’

7854

</td></tr>

7855

<tr><td align="left" valign="top"><a href="#Object-Messaging">5.6.2 Object Messaging</a></td><td>  </td><td align="left" valign="top"> Method Operator ‘<samp>:</samp>’

7856

</td></tr>

7857

<tr><td align="left" valign="top"><a href="#Object-Comparison">5.6.3 Object Comparison</a></td><td>  </td><td align="left" valign="top"> Equality ‘<samp>==</samp>’ and Inequality ‘<samp>~=</samp>’

7858

</td></tr>

7859

<tr><td align="left" valign="top"><a href="#Object-Existence">5.6.4 Object Existence</a></td><td>  </td><td align="left" valign="top"> Method ‘<samp>exists()</samp>’

7860

</td></tr>

7861

<tr><td align="left" valign="top"><a href="#Object-Kill">5.6.5 Object Kill</a></td><td>  </td><td align="left" valign="top"> Method ‘<samp>kill()</samp>’

7862

</td></tr>

7863

<tr><td align="left" valign="top"><a href="#Object-Kind-Check">5.6.6 Object Kind Check</a></td><td>  </td><td align="left" valign="top"> Method ‘<samp>kind()</samp>’ and ‘<samp>is()</samp>’

7864

</td></tr>

7865

<tr><td align="left" valign="top"><a href="#Object-Coordinate-Access">5.6.7 Object Coordinate Access</a></td><td>  </td><td align="left" valign="top"> Index Operators ‘<samp>["x"]</samp>’, ‘<samp>["y"]</samp>’

7866

</td></tr>

7867

<tr><td align="left" valign="top"><a href="#Object-Addition-and-Subtraction">5.6.8 Object Addition and Subtraction</a></td><td>  </td><td align="left" valign="top"> Operators ‘<samp>+</samp>’, ‘<samp>-</samp>’

7868

</td></tr>

7869

<tr><td align="left" valign="top"><a href="#Object-Center">5.6.9 Object Center</a></td><td>  </td><td align="left" valign="top"> Operator ‘<samp>#</samp>’

7870

</td></tr>

7871

<tr><td align="left" valign="top"><a href="#Object-Join">5.6.10 Object Join</a></td><td>  </td><td align="left" valign="top"> Operator ‘<samp>+</samp>’

7872

</td></tr>

7873

<tr><td align="left" valign="top"><a href="#Object-Intersection">5.6.11 Object Intersection</a></td><td>  </td><td align="left" valign="top"> Operator ‘<samp>*</samp>’

7874

</td></tr>

7875

<tr><td align="left" valign="top"><a href="#Object-Difference">5.6.12 Object Difference</a></td><td>  </td><td align="left" valign="top"> Operator ‘<samp>-</samp>’

7876

</td></tr>

7877

<tr><td align="left" valign="top"><a href="#Object-Sound">5.6.13 Object Sound</a></td><td>  </td><td align="left" valign="top"> Method ‘<samp>sound()</samp>’

7878

</td></tr>

7879

</table>

7880

7881

7882

7883

7884

7885

7886

7887

7888

7889

7890

7891

7892

7893

7894

7895

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

7896

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

7897

7898

</tr></table>

7899

7900

<h3 class="subsection">5.6.1 Object Attribute Access</h3>

7901

7902

7903

<dt> Syntax:</dt>

7904

<dd>result = obj["attributename"]

7905

7906

obj["attributename"] = value

7907

7908

obj:set({attributename1=value1, attributename2=value2,...})

7909

7910

</dd>

7911

<dt> Details:</dt>

7912

<dd>Read or write object attributes as described in the following chapters or

7913

custom attributes. The ‘<samp>set</samp>’ method allows you to set multiple attributes

7914

at once. Attribute writes are ignored if the object reference is invalid.

7915

Attribute reads require a valid object reference. Otherwise they return

7916

‘<samp>nil</samp>’.

7917

7918

</dd>

7919

<dt> Syntax Samples:</dt>

7920

<dd><table><tr><td> </td><td><pre class="example"><var>value</var> = <var>obj</var>["color"]

7921

<var>value</var> = <var>obj</var>.color

7922

<var>obj</var>["color"] = <var>BLACK</var>

7923

<var>obj</var>.color = <var>BLACK</var>

7924

<var>obj</var>:set({target=<var>mydoor</var>, action="open"})

7925

</pre></td></tr></table>

7926

</dd>

7927

</dl>

7928

7929

7930

7931

7932

7933

7934

7935

7936

7937

7938

7939

7940

7941

7942

7943

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

7944

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

7945

7946

</tr></table>

7947

7948

<h3 class="subsection">5.6.2 Object Messaging</h3>

7949

7950

7951

<dt> Syntax:</dt>

7952

<dd>result = obj:message("msg", value)

7953

7954

result = obj:msg(value)

7955

7956

</dd>

7957

<dt> Details:</dt>

7958

<dd>Send a message with a given value or ‘<samp>nil</samp>’ to the object. Every message

7959

can be sent directly as a method with the given message name. When the object

7960

reference is invalid the message is simply ignored.

7961

7962

</dd>

7963

<dt> Syntax Samples:</dt>

7964

<dd><table><tr><td> </td><td><pre class="example"><var>value</var> = <var>obj</var>:message("open")

7965

<var>value</var> = <var>obj</var>:open()

7966

<var>value</var> = <var>obj</var>:message("signal", <var>1</var>)

7967

<var>value</var> = <var>obj</var>:signal(<var>1</var>)

7968

</pre></td></tr></table>

7969

</dd>

7970

</dl>

7971

7972

7973

7974

7975

7976

7977

7978

7979

7980

7981

7982

7983

7984

7985

7986

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

7987

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

7988

7989

</tr></table>

7990

7991

<h3 class="subsection">5.6.3 Object Comparison</h3>

7992

7993

7994

<dt> Syntax:</dt>

7995

<dd>result = obj1 <==|~=> obj2

7996

7997

</dd>

7998

<dt> Details:</dt>

7999

<dd>A comparison of two object values. Two object values are equal if both

8000

reference the same, still existing world object. Otherwise they are unequal.

8001

8002

</dd>

8003

<dt> Syntax Samples:</dt>

8004

<dd><table><tr><td> </td><td><pre class="example"><var>bool</var> = <var>obj1</var> == <var>obj1</var> -- = true

8005

<var>bool</var> = <var>obj1</var> == <var>obj2</var> -- = false, if two different objects

8006

<var>bool</var> = <var>obj1</var> ~= <var>obj2</var> -- = true, if two different objects

8007

</pre></td></tr></table>

8008

</dd>

8009

</dl>

8010

8011

8012

8013

8014

8015

8016

8017

8018

8019

8020

8021

8022

8023

8024

8025

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

8026

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

8027

8028

</tr></table>

8029

8030

<h3 class="subsection">5.6.4 Object Existence</h3>

8031

8032

8033

<dt> Syntax:</dt>

8034

<dd>result = -obj

8035

8036

result = obj:exists()

8037

8038

</dd>

8039

<dt> Details:</dt>

8040

<dd>Checks whether an object reference is still valid. Returns true if the object

8041

still exists, otherwise false is returned for ‘<samp>NULL</samp>’ object references.

8042

8043

</dd>

8044

<dt> Syntax Samples:</dt>

8045

8046

<var>bool</var> = <var>obj</var>:exists()

8047

</pre></td></tr></table>

8048

</dd>

8049

</dl>

8050

8051

8052

8053

8054

8055

8056

8057

8058

8059

8060

8061

8062

8063

8064

8065

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

8066

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

8067

8068

</tr></table>

8069

8070

<h3 class="subsection">5.6.5 Object Kill</h3>

8071

8072

8073

<dt> Syntax:</dt>

8074

<dd>obj:kill()

8075

8076

</dd>

8077

<dt> Details:</dt>

8078

<dd>Kills the object at once. Note that you should never kill a sender object

8079

within a callback action. If you have need of killing the sender then add

8080

the attribute <a href="#safeaction">safeaction</a> as explained in <a href="#Target-_002d-Action">Target - Action</a>.

8081

8082

</dd>

8083

<dt> Syntax Samples:</dt>

8084

<dd><table><tr><td> </td><td><pre class="example"><var>obj</var>:kill()

8085

</pre></td></tr></table>

8086

</dd>

8087

</dl>

8088

8089

8090

8091

8092

8093

8094

8095

8096

8097

8098

8099

8100

8101

8102

8103

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

8104

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

8105

8106

</tr></table>

8107

8108

<h3 class="subsection">5.6.6 Object Kind Check</h3>

8109

8110

8111

<dt> Syntax:</dt>

8112

<dd>result = obj:is("kind")

8113

8114

result = obj:kind()

8115

8116

</dd>

8117

<dt> Details:</dt>

8118

<dd>These methods allow you to check or retrieve the <a href="#Object-Kind">Object Kind</a>.

8119

8120

</dd>

8121

<dt> Syntax Samples:</dt>

8122

<dd><table><tr><td> </td><td><pre class="example"><var>bool</var> = <var>obj</var>:is("st_chess")

8123

<var>string</var> = <var>obj</var>:kind()

8124

</pre></td></tr></table>

8125

</dd>

8126

</dl>

8127

8128

8129

8130

8131

8132

8133

8134

8135

8136

8137

8138

8139

8140

8141

8142

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

8143

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

8144

8145

</tr></table>

8146

8147

<h3 class="subsection">5.6.7 Object Coordinate Access</h3>

8148

8149

8150

<dt> Syntax:</dt>

8151

<dd>result = obj["x"]

8152

8153

result = obj["y"]

8154

8155

result1, result2 = obj:xy()

8156

8157

</dd>

8158

<dt> Details:</dt>

8159

<dd>The single position coordinates of an object can be read anytime. You can

8160

retrieve single coordinates by Lua square bracket index access. Of course you

8161

can use the Lua alternative dot index access syntax, too (see examples). If you

8162

want to evaluate both coordinates, you can make use of the method ‘<samp>xy()</samp>’,

8163

that returns both numbers at once in a Lua multiple assignment. Anyway the

8164

coordinates of an object are read only. You can not reposition an object by

8165

changing its coordinates.

8166

8167

</dd>

8168

<dt> Syntax Samples:</dt>

8169

<dd><table><tr><td> </td><td><pre class="example"><var>number</var> = <var>obj</var>["x"]

8170

<var>number</var> = <var>obj</var>.x

8171

<var>number</var> = <var>obj</var>["y"]

8172

<var>number</var> = <var>obj</var>.y

8173

<var>number1</var>, <var>number2</var> = <var>obj</var>:xy()

8174

</pre></td></tr></table>

8175

</dd>

8176

</dl>

8177

8178

8179

8180

8181

8182

8183

8184

8185

8186

8187

8188

8189

8190

8191

8192

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

8193

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

8194

8195

</tr></table>

8196

8197

<h3 class="subsection">5.6.8 Object Addition and Subtraction</h3>

8198

8199

8200

<dt> Syntax:</dt>

8201

<dd>result = obj <+|-> <pos | obj | cpos | polist>

8202

8203

result = <pos | obj | cpos | polist> <+|-> obj

8204

8205

</dd>

8206

<dt> Details:</dt>

8207

<dd>When an object is added to or subtracted from another position or data

8208

convertible to a position the result is the position value representing the

8209

vectorial addition or difference of both positions.

8210

8211

If an object is added to or subtracted from a position list a new list is created

8212

with the positions representing the sum or difference of the position with every

8213

member of the supplied position list.

8214

8215

</dd>

8216

<dt> Syntax Samples:</dt>

8217

<dd><table><tr><td> </td><td><pre class="example"><var>newpos</var> = <var>obj</var> + {<var>1</var>, <var>2</var>}

8218

<var>newpos</var> = <var>myobject</var> - <var>obj</var>

8219

<var>newpolist</var> = <var>obj</var> + <var>NEIGHBORS_4</var>

8220

<var>newpolist</var> = po["<var>myfloor</var>#*"] - <var>obj</var>

8221

</pre></td></tr></table>

8222

</dd>

8223

</dl>

8224

8225

8226

8227

8228

8229

8230

8231

8232

8233

8234

8235

8236

8237

8238

8239

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

8240

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

8241

8242

</tr></table>

8243

8244

<h3 class="subsection">5.6.9 Object Center</h3>

8245

8246

8247

<dt> Syntax:</dt>

8248

<dd>result = #obj

8249

8250

</dd>

8251

<dt> Details:</dt>

8252

<dd>A rounding of an objects position vector to the center of the grid. A new

8253

position value with coordinates of the center of the containing grid position

8254

is returned.

8255

8256

</dd>

8257

<dt> Syntax Samples:</dt>

8258

<dd><table><tr><td> </td><td><pre class="example"><var>newpos</var> = #<var>obj</var> -- e.g. po(3.5, 4.5)

8259

</pre></td></tr></table>

8260

</dd>

8261

</dl>

8262

8263

8264

8265

8266

8267

8268

8269

8270

8271

8272

8273

8274

8275

8276

8277

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

8278

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

8279

8280

</tr></table>

8281

8282

<h3 class="subsection">5.6.10 Object Join</h3>

8283

8284

8285

<dt> Syntax:</dt>

8286

<dd>result = obj + group

8287

8288

result = group + obj

8289

8290

</dd>

8291

<dt> Details:</dt>

8292

<dd>A new set containing the objects of the group plus the single object is returned.

8293

The object sequence is maintained. If the object is already member of the group

8294

the new group will contain just one object reference, namely the first one in

8295

sequence.

8296

8297

</dd>

8298

<dt> Syntax Samples:</dt>

8299

<dd><table><tr><td> </td><td><pre class="example"><var>newgroup</var> = <var>obj1</var> + grp(<var>obj2</var>, <var>obj3</var>, <var>obj1</var>) -- = grp(obj1, obj2, obj3)

8300

<var>newgroup</var> = grp(<var>obj2</var>, <var>obj3</var>) + <var>obj1</var> -- = grp(obj2, obj3, obj1)

8301

</pre></td></tr></table>

8302

</dd>

8303

</dl>

8304

8305

8306

8307

8308

8309

8310

8311

8312

8313

8314

8315

8316

8317

8318

8319

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

8320

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

8321

8322

</tr></table>

8323

8324

<h3 class="subsection">5.6.11 Object Intersection</h3>

8325

8326

8327

<dt> Syntax:</dt>

8328

<dd>result = obj * group

8329

8330

result = group * obj

8331

8332

</dd>

8333

<dt> Details:</dt>

8334

<dd>A new set containing just the object itself, in case it is part of the group,

8335

too, or an empty group returned.

8336

8337

</dd>

8338

<dt> Syntax Samples:</dt>

8339

<dd><table><tr><td> </td><td><pre class="example"><var>newgroup</var> = <var>obj1</var> * grp(<var>obj1</var>, <var>obj2</var>) -- = grp(obj1)

8340

<var>newgroup</var> = grp(<var>obj2</var>) * <var>obj1</var> -- = grp()

8341

</pre></td></tr></table>

8342

</dd>

8343

</dl>

8344

8345

8346

8347

8348

8349

8350

8351

8352

8353

8354

8355

8356

8357

8358

8359

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

8360

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

8361

8362

</tr></table>

8363

8364

<h3 class="subsection">5.6.12 Object Difference</h3>

8365

8366

8367

<dt> Syntax:</dt>

8368

<dd>result = obj - group

8369

8370

result = group - obj

8371

8372

</dd>

8373

<dt> Details:</dt>

8374

<dd>In the first case a new set containing just the object itself, if it is not part

8375

of the group, too, or an empty group returned. In the second case the new group

8376

contains all members of the old group without the object. The sequence of

8377

objects remains untouched.

8378

8379

</dd>

8380

<dt> Syntax Samples:</dt>

8381

<dd><table><tr><td> </td><td><pre class="example"><var>newgroup</var> = <var>obj1</var> - grp(<var>obj2</var>, <var>obj1</var>) -- = grp()

8382

<var>newgroup</var> = grp(<var>obj1</var>, <var>obj2</var>) - <var>obj1</var> -- = grp(obj2)

8383

</pre></td></tr></table>

8384

</dd>

8385

</dl>

8386

8387

8388

8389

8390

8391

8392

8393

8394

8395

8396

8397

8398

8399

8400

8401

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

8402

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

8403

8404

</tr></table>

8405

8406

<h3 class="subsection">5.6.13 Object Sound</h3>

8407

8408

8409

<dt> Syntax:</dt>

8410

<dd>result = obj:sound("name", volume)

8411

8412

</dd>

8413

<dt> Details:</dt>

8414

<dd>Play a sound of given name at the position of the object. The volume defaults

8415

to ‘<samp>1</samp>’.

8416

8417

</dd>

8418

<dt> Syntax Samples:</dt>

8419

<dd><table><tr><td> </td><td><pre class="example"><var>obj</var>:sound("quake")

8420

<var>obj</var>:sound("quake", <var>2</var>)

8421

</pre></td></tr></table>

8422

</dd>

8423

</dl>

8424

8425

8426

8427

8428

8429

8430

8431

8432

8433

8434

8435

8436

8437

8438

8439

8440

8441

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

8442

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

8443

8444

</tr></table>

8445

8446

<h2 class="section">5.7 Group</h2>

8447

8448

A group is a sorted set of <a href="#Object">Object</a>s. Every object can be contained just

8449

in one instance in the group. In contrast to a Lua table the group is a constant

8450

value datatype. Once you retrieved a group it can not be modified. But you can

8451

calculate and apply operators like join, intersection and difference on

8452

groups and generate thereby other group values as results.

8453

8454

Even though groups as values are long living you should be careful in keeping

8455

a group longer than a callback evaluation. Groups contain object references and

8456

objects can be killed. Thus a prior retrieved group may contain invalid

8457

object references on a subsequent callback evaluation. This may be uncritical

8458

if you just send a message to a group, but in other cases you may need to

8459

clean the group from invalid members (see below).

8460

8461

You create a group by listing the contained objects as arguments to the

8462

‘<samp>grp()</samp>’ <a href="#Functions">Functions</a>, by retrieving objects from the <a href="#NamedObjects">NamedObjects</a>

8463

repository or as result of other methods and calculations.

8464

8465

As groups are constant the sequence of contained objects is stable. All

8466

operations that generate resulting new groups maintain this sequence as far

8467

as possible. E.g. a join of two groups takes the objects of the first group

8468

in the given sequence and appends the additional objects of the second group

8469

in the sequence they appear in the second group.

8470

8471

All group operations that return new groups clean their results from any

8472

meanwhile invalid ‘<samp>NULL</samp>’ object references. You can use this feature

8473

to clean a group by the function ‘<samp>grp()</samp>’.

8474

8475

Any message sent to a group will be forwarded to all its members in sequence.

8476

An attribute write access to a group results in series of attribute writes

8477

on every group member in sequence, too.

8478

8479

But of course you can iterate over a group and access every member by index

8480

access. Several special methods for common group evaluations like shuffling,

8481

subgroup, sort, etc. are supported, too.

8482

8483

For task driven samples see section <a href="#Group-Tasks">Group Tasks</a>.

8484

8485

8486

<tr><td align="left" valign="top"><a href="#Group-Messaging">5.7.1 Group Messaging</a></td><td>  </td><td align="left" valign="top"> Method Operator ‘<samp>:</samp>’

8487

</td></tr>

8488

<tr><td align="left" valign="top"><a href="#Group-Attribute-Write">5.7.2 Group Attribute Write</a></td><td>  </td><td align="left" valign="top"> Index Operators ‘<samp>[]</samp>’

8489

</td></tr>

8490

<tr><td align="left" valign="top"><a href="#Group-Comparison">5.7.3 Group Comparison</a></td><td>  </td><td align="left" valign="top"> Equality ‘<samp>==</samp>’ and Inequality ‘<samp>~=</samp>’

8491

</td></tr>

8492

<tr><td align="left" valign="top"><a href="#Group-Length">5.7.4 Group Length</a></td><td>  </td><td align="left" valign="top"> Operator ‘<samp>#</samp>’

8493

</td></tr>

8494

<tr><td align="left" valign="top"><a href="#Group-Member-Access">5.7.5 Group Member Access</a></td><td>  </td><td align="left" valign="top"> Index Operators ‘<samp>[]</samp>’

8495

</td></tr>

8496

<tr><td align="left" valign="top"><a href="#Group-Loop">5.7.6 Group Loop</a></td><td>  </td><td align="left" valign="top"> ‘<samp>for obj in group do ... end</samp>’

8497

</td></tr>

8498

<tr><td align="left" valign="top"><a href="#Group-Join">5.7.7 Group Join</a></td><td>  </td><td align="left" valign="top"> Operator ‘<samp>+</samp>’

8499

</td></tr>

8500

<tr><td align="left" valign="top"><a href="#Group-Intersection">5.7.8 Group Intersection</a></td><td>  </td><td align="left" valign="top"> Operator ‘<samp>*</samp>’

8501

</td></tr>

8502

<tr><td align="left" valign="top"><a href="#Group-Difference">5.7.9 Group Difference</a></td><td>  </td><td align="left" valign="top"> Operator ‘<samp>-</samp>’

8503

</td></tr>

8504

<tr><td align="left" valign="top"><a href="#Group-Shuffle">5.7.10 Group Shuffle</a></td><td>  </td><td align="left" valign="top"> Method ‘<samp>shuffle()</samp>’

8505

</td></tr>

8506

<tr><td align="left" valign="top"><a href="#Group-Sorting">5.7.11 Group Sorting</a></td><td>  </td><td align="left" valign="top"> Method ‘<samp>sort()</samp>’

8507

</td></tr>

8508

<tr><td align="left" valign="top"><a href="#Group-Subset">5.7.12 Group Subset</a></td><td>  </td><td align="left" valign="top"> Method ‘<samp>sub()</samp>’

8509

</td></tr>

8510

<tr><td align="left" valign="top"><a href="#Group-Nearest-Object">5.7.13 Group Nearest Object</a></td><td>  </td><td align="left" valign="top"> Method ‘<samp>nearest()</samp>’

8511

</td></tr>

8512

</table>

8513

8514

8515

8516

8517

8518

8519

8520

8521

8522

8523

8524

8525

8526

8527

8528

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

8529

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

8530

8531

</tr></table>

8532

8533

<h3 class="subsection">5.7.1 Group Messaging</h3>

8534

8535

8536

<dt> Syntax:</dt>

8537

<dd>result = group:message("msg", value)

8538

8539

result = group:msg(value)

8540

8541

</dd>

8542

<dt> Details:</dt>

8543

<dd>Send a message with a given value or ‘<samp>nil</samp>’ to all objects in the group.

8544

Every message can be sent directly as a method with the given message name.

8545

When an object reference is invalid the message is simply ignored. The result

8546

is the return value of the message to the last object in the group, or ‘<samp>nil</samp>’

8547

for an empty group.

8548

8549

You are even allowed to send a ‘<samp>kill()</samp>’ message to all objects in a group.

8550

The objects will be killed, but the group remains filled with invalid ‘<samp>NULL</samp>’

8551

object references.

8552

8553

</dd>

8554

<dt> Syntax Samples:</dt>

8555

<dd><table><tr><td> </td><td><pre class="example"><var>value</var> = <var>group</var>:message("open")

8556

<var>value</var> = <var>group</var>:open()

8557

<var>value</var> = <var>group</var>:message("signal", <var>1</var>)

8558

<var>value</var> = <var>group</var>:signal(<var>1</var>)

8559

<var>value</var> = <var>group</var>:kill()

8560

</pre></td></tr></table>

8561

</dd>

8562

</dl>

8563

8564

8565

8566

8567

8568

8569

8570

8571

8572

8573

8574

8575

8576

8577

8578

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

8579

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

8580

8581

</tr></table>

8582

8583

<h3 class="subsection">5.7.2 Group Attribute Write</h3>

8584

8585

8586

<dt> Syntax:</dt>

8587

<dd>group["attributename"] = value

8588

8589

group:set({attributename1=value1, attributename2=value2,...})

8590

8591

</dd>

8592

<dt> Details:</dt>

8593

<dd>Set attributes as described in the following chapters or custom attributes on

8594

all objects of the group. The ‘<samp>set</samp>’ method allows you to set multiple

8595

attributes at once. Attribute writes are ignored if an object reference is

8596

invalid. Attribute read on groups in not allowed - the group index read is

8597

overloaded as a group member access.

8598

8599

</dd>

8600

<dt> Syntax Samples:</dt>

8601

<dd><table><tr><td> </td><td><pre class="example"><var>group</var>["color"] = <var>BLACK</var>

8602

<var>group</var>.color = <var>BLACK</var>

8603

<var>group</var>:set({target=<var>mydoor</var>, action="open"})

8604

</pre></td></tr></table>

8605

</dd>

8606

</dl>

8607

8608

8609

8610

8611

8612

8613

8614

8615

8616

8617

8618

8619

8620

8621

8622

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

8623

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

8624

8625

</tr></table>

8626

8627

<h3 class="subsection">5.7.3 Group Comparison</h3>

8628

8629

8630

<dt> Syntax:</dt>

8631

<dd>result = group1 <==|~=> group2

8632

8633

</dd>

8634

<dt> Details:</dt>

8635

<dd>A comparison of two groups. Two groups are equal if both contain the same set

8636

of objects independent of their sequence within both groups. Otherwise they are

8637

unequal.

8638

8639

</dd>

8640

<dt> Syntax Samples:</dt>

8641

<dd><table><tr><td> </td><td><pre class="example"><var>bool</var> = grp(<var>obj1</var>, <var>obj2</var>) == grp(<var>obj2</var>, <var>obj1</var>) -- = true

8642

<var>bool</var> = grp(<var>obj1</var>, <var>obj2</var>) == grp(<var>obj1</var>, <var>obj3</var>) -- = false, if different object contents

8643

<var>bool</var> = grp(<var>obj1</var>) ~= grp(<var>obj2</var>, <var>obj1</var>) -- = true, if different object contents

8644

</pre></td></tr></table>

8645

</dd>

8646

</dl>

8647

8648

8649

8650

8651

8652

8653

8654

8655

8656

8657

8658

8659

8660

8661

8662

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

8663

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

8664

8665

</tr></table>

8666

8667

<h3 class="subsection">5.7.4 Group Length</h3>

8668

8669

8670

<dt> Syntax:</dt>

8671

<dd>result = #group

8672

8673

</dd>

8674

<dt> Details:</dt>

8675

<dd>Number of objects contained in the group. Invalid ‘<samp>NULL</samp>’ object references

8676

are counted, too.

8677

8678

</dd>

8679

<dt> Syntax Samples:</dt>

8680

<dd><table><tr><td> </td><td><pre class="example"><var>number</var> = #grp(<var>obj1</var>, <var>obj2</var>) -- = 2

8681

for <var>i</var> = <var>1</var>, #<var>group</var> do <var>obj</var> = <var>group</var>[<var>i</var>] ... end

8682

</pre></td></tr></table>

8683

</dd>

8684

</dl>

8685

8686

8687

8688

8689

8690

8691

8692

8693

8694

8695

8696

8697

8698

8699

8700

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

8701

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

8702

8703

</tr></table>

8704

8705

<h3 class="subsection">5.7.5 Group Member Access</h3>

8706

8707

8708

<dt> Syntax:</dt>

8709

<dd>result = group[index]

8710

8711

result = group[obj]

8712

8713

</dd>

8714

<dt> Details:</dt>

8715

<dd>An index like read access with an index number between 1 and #group returns

8716

the object in the related group sequence position. Negative indices between

8717

-#group and -1 give the same objects. Thus you can always access the last

8718

object at index -1. All other index positions return an invalid ‘<samp>NULL</samp>’

8719

object - not ‘<samp>nil</samp>’ as tables do! Thus you are always able to send messages

8720

to returned object references.

8721

8722

An index like read access with an object as index returns the sequence position

8723

number, the number index, of the object if it is contained in the group or

8724

‘<samp>nil</samp>’ if it is not contained.

8725

8726

</dd>

8727

<dt> Syntax Samples:</dt>

8728

<dd><table><tr><td> </td><td><pre class="example"><var>object</var> = grp(<var>obj1</var>, <var>obj2</var>)[2] -- = obj2

8729

<var>object</var> = grp(<var>obj1</var>, <var>obj2</var>)[-1] -- = obj2

8730

<var>object</var> = grp(<var>obj1</var>, <var>obj2</var>)[0] -- = NULL object

8731

for <var>i</var> = <var>1</var>, #<var>group</var> do <var>obj</var> = <var>group</var>[<var>i</var>] ... end

8732

<var>number</var> = grp(<var>obj1</var>, <var>obj2</var>)[<var>obj2</var>] -- = 2

8733

<var>number</var> = grp(<var>obj1</var>, <var>obj2</var>)[<var>obj3</var>] -- = nil

8734

</pre></td></tr></table>

8735

</dd>

8736

</dl>

8737

8738

8739

8740

8741

8742

8743

8744

8745

8746

8747

8748

8749

8750

8751

8752

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

8753

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

8754

8755

</tr></table>

8756

8757

<h3 class="subsection">5.7.6 Group Loop</h3>

8758

8759

8760

<dt> Syntax:</dt>

8761

<dd>for obj in group do ... end

8762

8763

</dd>

8764

<dt> Details:</dt>

8765

<dd>Looping over all objects contained in a group. The loop occurs in the sequence

8766

of the contained objects and includes all objects, even invalid ‘<samp>NULL</samp>’

8767

object references.

8768

8769

</dd>

8770

<dt> Syntax Samples:</dt>

8771

<dd><table><tr><td> </td><td><pre class="example">for <var>obj</var> in <var>group</var> do <var>obj</var>:toggle() end

8772

</pre></td></tr></table>

8773

</dd>

8774

</dl>

8775

8776

8777

8778

8779

8780

8781

8782

8783

8784

8785

8786

8787

8788

8789

8790

8791

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

8792

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

8793

8794

</tr></table>

8795

8796

<h3 class="subsection">5.7.7 Group Join</h3>

8797

8798

8799

<dt> Syntax:</dt>

8800

<dd>result = group + <obj|group>

8801

8802

result = <obj|group> + group

8803

8804

8805

</dd>

8806

<dt> Details:</dt>

8807

<dd>A new set containing any object of both arguments just once, is returned. The

8808

object sequence is maintained. If an object is member of both arguments the new

8809

group will contain just one object reference, namely the first one in sequence.

8810

8811

</dd>

8812

<dt> Syntax Samples:</dt>

8813

<dd><table><tr><td> </td><td><pre class="example"><var>newgroup</var> = <var>obj1</var> + grp(<var>obj2</var>, <var>obj3</var>, <var>obj1</var>) -- = grp(obj1, obj2, obj3)

8814

<var>newgroup</var> = grp(<var>obj2</var>, <var>obj3</var>) + grp(<var>obj1</var>, <var>obj3</var>) -- = grp(obj2, obj3, obj1)

8815

</pre></td></tr></table>

8816

</dd>

8817

</dl>

8818

8819

8820

8821

8822

8823

8824

8825

8826

8827

8828

8829

8830

8831

8832

8833

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

8834

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

8835

8836

</tr></table>

8837

8838

<h3 class="subsection">5.7.8 Group Intersection</h3>

8839

8840

8841

<dt> Syntax:</dt>

8842

<dd>result = <obj|group> * group

8843

8844

result = group * <obj|group>

8845

8846

</dd>

8847

<dt> Details:</dt>

8848

<dd>A new set containing just those objects that are contained in both arguments. The

8849

objects are returned in the same sequence as they appear in the first argument.

8850

8851

</dd>

8852

<dt> Syntax Samples:</dt>

8853

<dd><table><tr><td> </td><td><pre class="example"><var>newgroup</var> = <var>obj1</var> * grp(<var>obj2</var>, <var>obj1</var>) -- = grp(obj1)

8854

<var>newgroup</var> = grp(<var>obj1</var>, <var>obj2</var>) * grp(<var>obj2</var>, <var>obj1</var>, <var>obj3</var>) -- = grp(obj1, obj2)

8855

</pre></td></tr></table>

8856

</dd>

8857

</dl>

8858

8859

8860

8861

8862

8863

8864

8865

8866

8867

8868

8869

8870

8871

8872

8873

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

8874

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

8875

8876

</tr></table>

8877

8878

<h3 class="subsection">5.7.9 Group Difference</h3>

8879

8880

8881

<dt> Syntax:</dt>

8882

<dd>result = <obj|group> - group

8883

8884

result = group - <obj|group>

8885

8886

</dd>

8887

<dt> Details:</dt>

8888

<dd>A new set containing just those objects of the first argument, that are not

8889

contained in the second argument is returned. The sequence of the objects

8890

in the new group is the same as in the first argument.

8891

8892

</dd>

8893

<dt> Syntax Samples:</dt>

8894

<dd><table><tr><td> </td><td><pre class="example"><var>newgroup</var> = <var>obj1</var> - grp(<var>obj2</var>, <var>obj1</var>) -- = grp()

8895

<var>newgroup</var> = grp(<var>obj1</var>, <var>obj2</var>, <var>obj3</var>) - grp(<var>obj2</var>, <var>obj4</var>) -- = grp(obj1, obj3)

8896

</pre></td></tr></table>

8897

</dd>

8898

</dl>

8899

8900

8901

8902

8903

8904

8905

8906

8907

8908

8909

8910

8911

8912

8913

8914

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

8915

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

8916

8917

</tr></table>

8918

8919

<h3 class="subsection">5.7.10 Group Shuffle</h3>

8920

8921

8922

<dt> Syntax:</dt>

8923

<dd>result = group:shuffle()

8924

8925

</dd>

8926

<dt> Details:</dt>

8927

<dd>Returns a new group with the same objects in another random sequence. Note that

8928

all invalid ‘<samp>NULL</samp>’ object references are removed in the resulting group by

8929

this method call.

8930

8931

</dd>

8932

<dt> Syntax Samples:</dt>

8933

<dd><table><tr><td> </td><td><pre class="example"><var>newgroup</var> = grp(<var>obj1</var>, <var>obj2</var>)

8934

</pre></td></tr></table>

8935

</dd>

8936

</dl>

8937

8938

8939

8940

8941

8942

8943

8944

8945

8946

8947

8948

8949

8950

8951

8952

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

8953

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

8954

8955

</tr></table>

8956

8957

<h3 class="subsection">5.7.11 Group Sorting</h3>

8958

8959

8960

<dt> Syntax:</dt>

8961

<dd>result = group:sort("circular")

8962

8963

result = group:sort("linear" <, direction>)

8964

8965

result = group:sort()

8966

8967

</dd>

8968

<dt> Details:</dt>

8969

<dd>Returns a new group with the same objects in another sorted sequence. Note that

8970

all invalid ‘<samp>NULL</samp>’ object reference are removed in the resulting group by

8971

this method call.

8972

8973

With a string argument <code>"circular"</code> the objects are arranged around their

8974

center by their angle. The distance from this center has no influence.

8975

8976

With a string argument <code>"linear"</code> the objects are arranged in a linear

8977

fashion. You either supply a <a href="#Position">Position</a> as sorting direction vector, or

8978

the first two objects of the group will define the sorting direction as default.

8979

8980

If no sorting argument is supplied the objects will be sorted by their name

8981

in lexical order.

8982

8983

</dd>

8984

<dt> Syntax Samples:</dt>

8985

<dd><table><tr><td> </td><td><pre class="example"><var>newgroup</var> = grp(<var>obj1</var>, <var>obj2</var>, <var>obj3</var>):sort("linear", po(2,1))

8986

<var>newgroup</var> = grp(<var>obj1</var>, <var>obj2</var>, <var>obj3</var>):sort("circular")

8987

<var>newgroup</var> = grp(<var>obj1</var>, <var>obj2</var>, <var>obj3</var>):sort()

8988

</pre></td></tr></table>

8989

</dd>

8990

</dl>

8991

8992

8993

8994

8995

8996

8997

8998

8999

9000

9001

9002

9003

9004

9005

9006

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

9007

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

9008

9009

</tr></table>

9010

9011

<h3 class="subsection">5.7.12 Group Subset</h3>

9012

9013

9014

<dt> Syntax:</dt>

9015

<dd>result = group:sub(number)

9016

9017

result = group:sub(start, end)

9018

9019

result = group:sub(start, -number)

9020

9021

</dd>

9022

<dt> Details:</dt>

9023

<dd>Returns a new group with a subset of the contained objects. The sequence of

9024

objects in the new group is identical to the sequence in the originating group.

9025

Note that all invalid ‘<samp>NULL</samp>’ object reference are removed in the resulting

9026

group by this method call after determination of the sub set candidate objects.

9027

9028

With a number as argument you determine the number of requested objects. A

9029

positive number returns the amount of objects starting with the first object

9030

of the group. Whereas a negative number returns objects from the tail of the

9031

group. In this case the absolute value determines the number of selected objects

9032

counted backwards from the last one in sequence.

9033

9034

With two positive numbers as arguments you define the first and the last sequence

9035

index of the requested subset.

9036

9037

With two numbers, but the second one being negative, you define the first object

9038

and the with the absolute value of the second number you define the amount of

9039

objects you want in your subset.

9040

9041

</dd>

9042

<dt> Syntax Samples:</dt>

9043

<dd><table><tr><td> </td><td><pre class="example"><var>newgroup</var> = grp(<var>obj1</var>, <var>obj2</var>, <var>obj3</var>, <var>obj4</var>):sub(2) -- = grp(obj1, obj2)

9044

<var>newgroup</var> = grp(<var>obj1</var>, <var>obj2</var>, <var>obj3</var>, <var>obj4</var>):sub(-2) -- = grp(obj3, obj4)

9045

<var>newgroup</var> = grp(<var>obj1</var>, <var>obj2</var>, <var>obj3</var>, <var>obj4</var>):sub(2, 4) -- = grp(obj2, obj3, obj4)

9046

<var>newgroup</var> = grp(<var>obj1</var>, <var>obj2</var>, <var>obj3</var>, <var>obj4</var>):sub(2, -2) -- = grp(obj2, obj3)

9047

</pre></td></tr></table>

9048

</dd>

9049

</dl>

9050

9051

9052

9053

9054

9055

9056

9057

9058

9059

9060

9061

9062

9063

9064

9065

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

9066

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

9067

9068

</tr></table>

9069

9070

<h3 class="subsection">5.7.13 Group Nearest Object</h3>

9071

9072

9073

<dt> Syntax:</dt>

9074

<dd>result = group:nearest(obj)

9075

9076

</dd>

9077

<dt> Details:</dt>

9078

<dd>Returns the object contained in the group that is nearest to the given reference

9079

object. The distances are calculated exactly without rounding actor positions.

9080

In case two objects have the same distance from the reference object one is

9081

chosen by chance as the result.

9082

9083

</dd>

9084

<dt> Syntax Samples:</dt>

9085

<dd><table><tr><td> </td><td><pre class="example"><var>newobject</var> = grp(<var>obj1</var>, <var>obj2</var>, <var>obj3</var>):nearest(<var>obj4</var>)

9086

</pre></td></tr></table>

9087

</dd>

9088

</dl>

9089

9090

9091

9092

9093

9094

9095

9096

9097

9098

9099

9100

9101

9102

9103

9104

9105

9106

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

9107

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

9108

9109

</tr></table>

9110

9111

<h2 class="section">5.8 NamedObjects</h2>

9112

9113

The datatype NamedObjects is used by just one object, the singleton repository

9114

of named objects. Whenever you name an object, see section <a href="#Object-Naming">Object Naming</a>, this

9115

repository registers its name and allows you to retrieve the object lateron

9116

by providing its name.

9117

9118

Being a singleton you can not create new NamedObjects. The singleton is stored

9119

at the global variable ‘<samp>no</samp>’ on level load.

9120

9121

9122

<tr><td align="left" valign="top"><a href="#NamedObjects-Repository-Request">5.8.1 NamedObjects Repository Request</a></td><td>  </td><td align="left" valign="top"> Index Operator ‘<samp>[]</samp>’ read

9123

</td></tr>

9124

<tr><td align="left" valign="top"><a href="#NamedObjects-Object-Naming">5.8.2 NamedObjects Object Naming</a></td><td>  </td><td align="left" valign="top"> Index Operator ‘<samp>[]</samp>’ write

9125

</td></tr>

9126

</table>

9127

9128

9129

9130

9131

9132

9133

9134

9135

9136

9137

9138

9139

9140

9141

9142

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

9143

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

9144

9145

</tr></table>

9146

9147

<h3 class="subsection">5.8.1 NamedObjects Repository Request</h3>

9148

9149

9150

<dt> Syntax:</dt>

9151

<dd>result = no["name"]

9152

9153

</dd>

9154

<dt> Details:</dt>

9155

<dd>Request of one or several objects from the repository. If no wildcard

9156

characters are used in the name an <a href="#Object">Object</a> value is returned. It is either

9157

the unique object with the given name, or an invalid ‘<samp>NULL</samp>’ object if no

9158

object exists with the given name.

9159

9160

If the requested name contains a wildcard character, either an asterisk ‘<samp>*</samp>’

9161

or a question mark ‘<samp>?</samp>’, a <a href="#Group">Group</a> containing all objects with matching

9162

names is returned. An asterisk matches zero, one or several arbitrary characters.

9163

A question mark matches a single arbitrary character. Both wildcard characters

9164

can be used anywhere in the string and in arbitrary multiplicity. Anyway the

9165

result is always returned as a <a href="#Group">Group</a>. The group may contain multiple

9166

objects, just a single object, or even no objects at all when no existing object

9167

matches your name pattern.

9168

9169

</dd>

9170

<dt> Syntax Samples:</dt>

9171

<dd><table><tr><td> </td><td><pre class="example"><var>obj</var> = no["<var>mydoor</var>"] -- exact name match

9172

<var>group</var> = no["<var>mydoors#*</var>"] -- any suffix

9173

<var>group</var> = no["<var>mydoor?</var>"] -- just one char suffix

9174

<var>group</var> = no["<var>mydoors?#*</var>"] -- matches e.g. "mydoorsA#123435", "mydoorsB#1213"

9175

</pre></td></tr></table>

9176

</dd>

9177

</dl>

9178

9179

9180

9181

9182

9183

9184

9185

9186

9187

9188

9189

9190

9191

9192

9193

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

9194

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

9195

9196

</tr></table>

9197

9198

<h3 class="subsection">5.8.2 NamedObjects Object Naming</h3>

9199

9200

9201

<dt> Syntax:</dt>

9202

<dd>no["name"] = obj

9203

9204

</dd>

9205

<dt> Details:</dt>

9206

<dd>Index write accesses to the singleton allows you to name or rename objects. Note

9207

that you can name or rename objects by <a href="#Object">Object</a> attribute writes, too.

9208

The object’s name is stored as attribute <code>"name"</code>. Both ways of naming

9209

an object are totally equivalent.

9210

9211

</dd>

9212

<dt> Syntax Samples:</dt>

9213

<dd><table><tr><td> </td><td><pre class="example">no["<var>myobject</var>"] = <var>obj</var>

9214

</pre></td></tr></table>

9215

</dd>

9216

</dl>

9217

9218

9219

9220

9221

9222

9223

9224

9225

9226

9227

9228

9229

9230

9231

9232

9233

9234

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

9235

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

9236

9237

</tr></table>

9238

9239

<h2 class="section">5.9 PositionList</h2>

9240

9241

A PositionList is a sorted set, known as list, of <a href="#Position">Position</a>s. Like a

9242

<a href="#Group">Group</a> this container is a constant datatype, that can not be modified. But

9243

you can easily compose new position lists by concatenation of existing lists and

9244

single positions.

9245

9246

An important difference to a group is the ability of a position list to store

9247

a position multiple times at different locations in its sequence. Thus a

9248

position list is suited to describe paths, even paths that are closed or

9249

cross itself.

9250

9251

As <a href="#Position">Position</a>s are values that never become invalid, position lists once

9252

created will never change or get invalid. They are true values themselves. Thus

9253

they are the containers of choice for longterm storage.

9254

9255

You can easily create a position list by <a href="#PositionList-Conversion">PositionList Conversion</a>, which

9256

is featured by the <a href="#Positions-Repository">Positions Repository</a> singleton and allows you to

9257

transform a group into a position list by the simple expression

9258

‘<samp>po(group)</samp>’. On the other hand you can retrieve all <a href="#Object">Object</a>s of a

9259

basic kind located along a position list path by <a href="#Functions">Functions</a> like

9260

‘<samp>st(polist)</samp>’, ‘<samp>it(polist)</samp>’ and ‘<samp>fl(polist)</samp>’.

9261

9262

As a unique floor object is guaranteed to be on every grid position, you can

9263

convert a given list of unique grid positions to a group of floors without

9264

loosing any information. Now you can apply all group methods on the floors, like

9265

shuffling, sorting, subgrouping, etc.. Finally you can convert the resulting

9266

group back to a persistent position list. Of course the conversions preserve

9267

the sequence of members.

9268

9269

Some additional position specific operators are supplied to allow simple

9270

translations and stretchings of position lists.

9271

9272

Note that in contrast to a <a href="#Group">Group</a> this datatype can not directly be stored

9273

in an <a href="#Object">Object</a> attribute. But you can always store a <a href="#Group">Group</a> of floors

9274

in an attribute. In case floors can be destroyed you may need to name these

9275

floors as discussed in <a href="#Named-Positions">Named Positions</a>.

9276

9277

For task driven samples see section <a href="#Named-Positions-Tasks">Named Positions Tasks</a>.

9278

9279

9280

<tr><td align="left" valign="top"><a href="#PositionList-Comparison">5.9.1 PositionList Comparison</a></td><td>  </td><td align="left" valign="top"> Equality ‘<samp>==</samp>’ and Inequality ‘<samp>~=</samp>’

9281

</td></tr>

9282

<tr><td align="left" valign="top"><a href="#PositionList-Length">5.9.2 PositionList Length</a></td><td>  </td><td align="left" valign="top"> Operator ‘<samp>#</samp>’

9283

</td></tr>

9284

<tr><td align="left" valign="top"><a href="#PositionList-Member-Access">5.9.3 PositionList Member Access</a></td><td>  </td><td align="left" valign="top"> Index Operators ‘<samp>[]</samp>’

9285

</td></tr>

9286

<tr><td align="left" valign="top"><a href="#PositionList-Concatenation">5.9.4 PositionList Concatenation</a></td><td>  </td><td align="left" valign="top"> Operator ‘<samp>..</samp>’

9287

</td></tr>

9288

<tr><td align="left" valign="top"><a href="#PositionList-Translation">5.9.5 PositionList Translation</a></td><td>  </td><td align="left" valign="top"> Operators ‘<samp>+</samp>’ and ‘<samp>-</samp>’

9289

</td></tr>

9290

<tr><td align="left" valign="top"><a href="#PositionList-Stretching">5.9.6 PositionList Stretching</a></td><td>  </td><td align="left" valign="top"> Operators ‘<samp>*</samp>’ and ‘<samp>/</samp>’

9291

</td></tr>

9292

</table>

9293

9294

9295

9296

9297

9298

9299

9300

9301

9302

9303

9304

9305

9306

9307

9308

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

9309

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

9310

9311

</tr></table>

9312

9313

<h3 class="subsection">5.9.1 PositionList Comparison</h3>

9314

9315

9316

<dt> Syntax:</dt>

9317

<dd>result = polist1 <==|~=> polist2

9318

9319

</dd>

9320

<dt> Details:</dt>

9321

<dd>A comparison of two position lists. Two position lists are equal if both contain

9322

the same positions in the identical sequence. Otherwise they are unequal.

9323

9324

</dd>

9325

<dt> Syntax Samples:</dt>

9326

<dd><table><tr><td> </td><td><pre class="example"><var>bool</var> = (po(<var>2</var>,<var>3</var>).. po(<var>5</var>,<var>7</var>)) == (po(<var>2</var>,<var>3</var>) .. po(<var>5</var>,<var>7</var>)) -- = true

9327

<var>bool</var> = (po(<var>2</var>,<var>3</var>).. po(<var>5</var>,<var>7</var>)) == (po(<var>4</var>,<var>0</var>) .. po(<var>5</var>,<var>7</var>)) -- = false, different positions

9328

<var>bool</var> = (po(<var>2</var>,<var>3</var>).. po(<var>5</var>,<var>7</var>)) == (po(<var>5</var>,<var>7</var>) .. po(<var>2</var>,<var>3</var>)) -- = false, different sequence

9329

</pre></td></tr></table>

9330

</dd>

9331

</dl>

9332

9333

9334

9335

9336

9337

9338

9339

9340

9341

9342

9343

9344

9345

9346

9347

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

9348

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

9349

9350

</tr></table>

9351

9352

<h3 class="subsection">5.9.2 PositionList Length</h3>

9353

9354

9355

<dt> Syntax:</dt>

9356

<dd>result = #polist

9357

9358

</dd>

9359

<dt> Details:</dt>

9360

<dd>Number of positions contained in the list.

9361

9362

</dd>

9363

<dt> Syntax Samples:</dt>

9364

<dd><table><tr><td> </td><td><pre class="example"><var>number</var> = #(po(<var>2</var>,<var>3</var>) .. po(<var>5</var>,<var>7</var>)) -- = 2

9365

for <var>i</var> = <var>1</var>, #<var>polist</var> do <var>pos</var> = <var>polist</var>[<var>i</var>] ... end

9366

</pre></td></tr></table>

9367

</dd>

9368

</dl>

9369

9370

9371

9372

9373

9374

9375

9376

9377

9378

9379

9380

9381

9382

9383

9384

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

9385

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

9386

9387

</tr></table>

9388

9389

<h3 class="subsection">5.9.3 PositionList Member Access</h3>

9390

9391

9392

<dt> Syntax:</dt>

9393

<dd>result = group[index]

9394

9395

</dd>

9396

<dt> Details:</dt>

9397

<dd>An index like read access with an index number between 1 and #polist returns

9398

the position in the related position list position. Negative indices between

9399

-#polist and -1 give the same positions. Thus you can always access the last

9400

position at index -1. All other indices return a Lua ‘<samp>nil</samp>’ value like

9401

tables.

9402

9403

</dd>

9404

<dt> Syntax Samples:</dt>

9405

<dd><table><tr><td> </td><td><pre class="example"><var>pos</var> = (po(<var>2</var>,<var>3</var>) .. po(<var>5</var>,<var>7</var>))[2] -- = po(5,7)

9406

<var>pos</var> = (po(<var>2</var>,<var>3</var>) .. po(<var>5</var>,<var>7</var>))[-1] -- = po(5,7)

9407

<var>pos</var> = (po(<var>2</var>,<var>3</var>) .. po(<var>5</var>,<var>7</var>))[0] -- = nil

9408

for <var>i</var> = <var>1</var>, #<var>polist</var> do <var>pos</var> = <var>polist</var>[<var>i</var>] ... end

9409

</pre></td></tr></table>

9410

</dd>

9411

</dl>

9412

9413

9414

9415

9416

9417

9418

9419

9420

9421

9422

9423

9424

9425

9426

9427

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

9428

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

9429

9430

</tr></table>

9431

9432

<h3 class="subsection">5.9.4 PositionList Concatenation</h3>

9433

9434

9435

<dt> Syntax:</dt>

9436

<dd>result = polist1 .. <pos | polist2>

9437

9438

result = <pos | polist1> .. polist2

9439

9440

</dd>

9441

<dt> Details:</dt>

9442

<dd>Concatenates two position lists or a position with a position list to a

9443

new PositionList containing all positions in the given order. Note that this

9444

operation is associative, that means it does not matter if you use braces in

9445

multiple concatenations or not.

9446

9447

</dd>

9448

<dt> Syntax Samples:</dt>

9449

<dd><table><tr><td> </td><td><pre class="example"><var>newpolist</var> = po(po(<var>2</var>,<var>3</var>), po(<var>5</var>,<var>7</var>)) .. po(<var>4</var>, <var>4</var>) -- = (2,3),(5,7),(4,4)

9450

</pre></td></tr></table>

9451

9452

</dd>

9453

<dt> Caveats:</dt>

9454

<dd>Note that due to the value nature of position lists the concatenation creates

9455

a new value. This is an expensive operation. When you are collecting potentially

9456

large number of positions in a loop, you should not concat each new candidate

9457

to an existing position list. Avoid the creation of numerous position list

9458

values and collect the positions in a standard Lua table. Convert this table

9459

at the end to a position list (See section <a href="#PositionList-Conversion">PositionList Conversion</a>).

9460

9461

<table><tr><td> </td><td><pre class="example"><var>result</var> = {}

9462

for <var>x</var> = 1, 200 do

9463

table.insert(<var>result</var>, po(<var>x</var>, 17))

9464

end

9465

return po(<var>result</var>)

9466

</pre></td></tr></table>

9467

9468

</dd>

9469

</dl>

9470

9471

9472

9473

9474

9475

9476

9477

9478

9479

9480

9481

9482

9483

9484

9485

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

9486

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

9487

9488

</tr></table>

9489

9490

<h3 class="subsection">5.9.5 PositionList Translation</h3>

9491

9492

9493

<dt> Syntax:</dt>

9494

<dd>result = polist <+|-> <pos | obj | cpos>

9495

9496

result = <pos | obj | cpos> <+|-> polist

9497

9498

</dd>

9499

<dt> Details:</dt>

9500

<dd>If a position or data convertible to a position is added to or subtracted from

9501

a position list a new list is created with the positions representing the sum or

9502

difference of the position with every member of the position list. In total the

9503

position list is shifted by the position as a vector.

9504

9505

</dd>

9506

<dt> Syntax Samples:</dt>

9507

<dd><table><tr><td> </td><td><pre class="example"><var>newpolist</var> = po(<var>2</var>, <var>3</var>) + <var>NEIGHBORS_4</var> -- po(1, 3) .. po(2, 4) .. po(3, 3) .. po(2, 2)

9508

<var>newpolist</var> = po["<var>myfloor</var>#*"] - po(<var>3</var>, <var>0</var>)

9509

</pre></td></tr></table>

9510

</dd>

9511

</dl>

9512

9513

9514

9515

9516

9517

9518

9519

9520

9521

9522

9523

9524

9525

9526

9527

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

9528

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

9529

9530

</tr></table>

9531

9532

<h3 class="subsection">5.9.6 PositionList Stretching</h3>

9533

9534

9535

<dt> Syntax:</dt>

9536

<dd>result = polist * number

9537

9538

result = number * polist

9539

9540

</dd>

9541

<dt> Details:</dt>

9542

<dd>A scalar multiplication or division of all positions in a position list. All

9543

position values are multiplicated or divided by the given number in both

9544

coordinate values. In total the position list is stretched by a scalar factor.

9545

9546

</dd>

9547

<dt> Syntax Samples:</dt>

9548

<dd><table><tr><td> </td><td><pre class="example"><var>newpolist</var> = <var>2</var> * <var>NEIGHBORS_4</var> -- = po(9, 12)

9549

<var>newpolist</var> = (po(<var>2</var>,<var>4</var>) .. po(<var>6</var>,<var>7</var>)) * <var>1/2</var> -- = (1, 2), (3, 3.5)

9550

</pre></td></tr></table>

9551

</dd>

9552

</dl>

9553

9554

9555

9556

9557

9558

9559

9560

9561

9562

9563

9564

9565

9566

9567

9568

9569

9570

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

9571

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

9572

9573

</tr></table>

9574

9575

<h2 class="section">5.10 Positions Repository</h2>

9576

9577

The Positions datatype is just used by a single instance, the singleton

9578

repository of named positions. Besides the management of named positions it

9579

provides useful conversions of other datatypes to position based types.

9580

9581

Being a singleton you can not create a new Positions Repository. The singleton

9582

that is available on level load is stored at the global variable ‘<samp>po</samp>’.

9583

9584

The position repository is an extension of the <a href="#NamedObjects">NamedObjects</a> repository.

9585

Whenever you name an object, See section <a href="#Object-Naming">Object Naming</a>, this repository registers

9586

its name and allows you to retrieve lateron the current object’s position by

9587

providing its name. But even when a floor object gets killed, its position

9588

entry remains stored as <a href="#Named-Positions">Named Positions</a>. Of course you can name positions

9589

yourself, but positions of existing named objects will always override plane

9590

named positions on name clashes.

9591

9592

For task driven samples see section <a href="#Named-Positions-Tasks">Named Positions Tasks</a>.

9593

9594

9595

<tr><td align="left" valign="top"><a href="#Positions-Repository-Request">5.10.1 Positions Repository Request</a></td><td>  </td><td align="left" valign="top"> Index Operator ‘<samp>[]</samp>’ read

9596

</td></tr>

9597

<tr><td align="left" valign="top"><a href="#Positions-Repository-Storage">5.10.2 Positions Repository Storage</a></td><td>  </td><td align="left" valign="top"> Index Operator ‘<samp>[]</samp>’ write

9598

</td></tr>

9599

<tr><td align="left" valign="top"><a href="#Position-Conversion">5.10.3 Position Conversion</a></td><td>  </td><td align="left" valign="top"> Function ‘<samp>po()</samp>’

9600

</td></tr>

9601

<tr><td align="left" valign="top"><a href="#PositionList-Conversion">5.10.4 PositionList Conversion</a></td><td>  </td><td align="left" valign="top"> Function ‘<samp>po()</samp>’

9602

</td></tr>

9603

</table>

9604

9605

9606

9607

9608

9609

9610

9611

9612

9613

9614

9615

9616

9617

9618

9619

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

9620

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

9621

9622

</tr></table>

9623

9624

<h3 class="subsection">5.10.1 Positions Repository Request</h3>

9625

9626

9627

<dt> Syntax:</dt>

9628

<dd>result = po["name"]

9629

9630

</dd>

9631

<dt> Details:</dt>

9632

<dd>Request of one or several positions from the repository. If no wildcard

9633

characters are used in the name the <a href="#Position">Position</a> value of the unique object

9634

with the given name, if existent, is returned. It no object exists with the

9635

name, the last position stored with the same name is returned. If no position

9636

exists the value ‘<samp>nil</samp>’ is returned.

9637

9638

If the requested name contains a wildcard character, either an asterisk ‘<samp>*</samp>’

9639

or a question mark ‘<samp>?</samp>’, a <a href="#PositionList">PositionList</a> containing all positions with

9640

matching names is returned. An asterisk matches zero, one or several arbitrary

9641

characters. A question mark matches a single arbitrary character. Both wildcard

9642

characters can be used anywhere in the string and in arbitrary multiplicity.

9643

Anyway the result is always returned as a <a href="#PositionList">PositionList</a>. The list may

9644

contain multiple positions, just a single position, or even no position at all

9645

when no existing position matches your name pattern.

9646

9647

</dd>

9648

<dt> Syntax Samples:</dt>

9649

<dd><table><tr><td> </td><td><pre class="example"><var>pos</var> = po["<var>mydoor</var>"] -- exact name match

9650

<var>polist</var> = po["<var>mydoors#*</var>"] -- any suffix

9651

<var>polist</var> = po["<var>mydoor?</var>"] -- just one char suffix

9652

<var>polist</var> = po["<var>mydoors?#*</var>"] -- matches e.g. "mydoorsA#123435", "mydoorsB#1213"

9653

</pre></td></tr></table>

9654

</dd>

9655

</dl>

9656

9657

9658

9659

9660

9661

9662

9663

9664

9665

9666

9667

9668

9669

9670

9671

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

9672

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

9673

9674

</tr></table>

9675

9676

<h3 class="subsection">5.10.2 Positions Repository Storage</h3>

9677

9678

9679

<dt> Syntax:</dt>

9680

<dd>po["name"] = obj

9681

9682

</dd>

9683

<dt> Details:</dt>

9684

<dd>Index write accesses to the singleton allows you to name or rename positions.

9685

Note that can not assign a new position to a name that currently references

9686

an existing <a href="#Object">Object</a>. Such write access are silently ignored.

9687

9688

</dd>

9689

<dt> Syntax Samples:</dt>

9690

<dd><table><tr><td> </td><td><pre class="example">po["<var>mypos</var>"] = <var>pos</var>

9691

</pre></td></tr></table>

9692

</dd>

9693

</dl>

9694

9695

9696

9697

9698

9699

9700

9701

9702

9703

9704

9705

9706

9707

9708

9709

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

9710

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

9711

9712

</tr></table>

9713

9714

<h3 class="subsection">5.10.3 Position Conversion</h3>

9715

9716

9717

<dt> Syntax:</dt>

9718

<dd>result = po(<obj | pos | {<var>x</var>, <var>y</var>} | <var>x</var>, <var>y</var> >)

9719

9720

</dd>

9721

<dt> Details:</dt>

9722

<dd>Converts its argument to a new position value.

9723

9724

</dd>

9725

<dt> Syntax Samples:</dt>

9726

<dd><table><tr><td> </td><td><pre class="example"><var>pos</var> = po(<var>pos2</var>)

9727

<var>pos</var> = po(<var>obj</var>)

9728

<var>pos</var> = po({<var>2</var>, <var>4</var>})

9729

<var>pos</var> = po(<var>3</var>, <var>7</var>)

9730

</pre></td></tr></table>

9731

</dd>

9732

</dl>

9733

9734

9735

9736

9737

9738

9739

9740

9741

9742

9743

9744

9745

9746

9747

9748

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

9749

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

9750

9751

</tr></table>

9752

9753

<h3 class="subsection">5.10.4 PositionList Conversion</h3>

9754

9755

9756

<dt> Syntax:</dt>

9757

<dd>result = po(group | {pos1, pos2, pos3})

9758

9759

</dd>

9760

<dt> Details:</dt>

9761

<dd>Converts the given group or table of positions to a new <a href="#PositionList">PositionList</a>

9762

value, that contains the positions of all valid group <a href="#Object">Object</a>s or table

9763

members in the same sequence.

9764

9765

</dd>

9766

<dt> Syntax Samples:</dt>

9767

<dd><table><tr><td> </td><td><pre class="example"><var>polist</var> = po(<var>group</var>)

9768

<var>polist</var> = po({po(<var>3</var>, <var>7</var>), po(<var>2</var>, <var>6</var>)})

9769

<var>polist</var> = po({}) -- an empty position list

9770

</pre></td></tr></table>

9771

</dd>

9772

</dl>

9773

9774

9775

9776

9777

9778

9779

9780

9781

9782

9783

9784

9785

9786

9787

9788

9789

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

9790

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

9791

9792

</tr></table>

9793

9794

<h2 class="section">5.11 Tile and Object Declaration</h2>

9795

9796

A tile is the description of one or several objects that should be positioned

9797

on the same grid position. A single object can be set up by a straight

9798

object declaration, an anonymous Lua table with entries for the object kind

9799

and all attributes. The object declaration comes in three minor variations:

9800

9801

<table><tr><td> </td><td><pre class="example">{"st_chess", name="<var>jumper</var>", color=<var>WHITE</var>}

9802

{"st_chess_white", "<var>jumper</var>", <var>_myattr</var>=<var>5</var>}

9803

{"ac_marble", 0.2, 0.6, name="<var>blacky</var>"}

9804

</pre></td></tr></table>

9805

9806

The first entry, the one stored at table position ‘<samp>1</samp>’, has always to be

9807

the kind name of a supported Enigma object. In the first example all other

9808

table entries are key value pairs with the key being the attribute name. The

9809

second example uses the shortcut of specifying the name attribute value as

9810

second table entry, that will be stored at table position ‘<samp>2</samp>’. It has to

9811

be a string value. The third variation, that is useful for actor declarations,

9812

stores the grid offsets in x and y directions in the table positions ‘<samp>2</samp>’ and

9813

‘<samp>3</samp>’. Of course you can not use the name attribute shortcut in the same

9814

declaration.

9815

9816

These table driven object declarations are always sufficient if you just want to

9817

set a single object at once. But tiles do often take an item or a stone besides

9818

a floor. So we need an Enigma data type being able to handle these multiple

9819

declarations. This is the ‘<samp>tile</samp>’ data type. It can take just one object

9820

declaration or an arbitrary list of declarations. You convert a table object

9821

declaration into a tile by the <a href="#Tiles-Repository">Tiles Repository</a> handle. Once you have a

9822

tile you can concat other tiles or table object declarations to set up new

9823

tiles.

9824

9825

Enigma guarantees that the objects will be set to the world in the sequence

9826

of declarations in the tile.

9827

9828

9829

9830

9831

9832

Even though in most cases you use object declarations and tiles to set objects

9833

you may need in some advanced usage cases to supply such a datatype in

9834

situations where you want to add nothing at all or even want to kill a

9835

possibly existing object. In these cases you can supply one of the pseudo object

9836

kind names <code>"fl_nil"</code>, <code>"it_nil"</code>, <code>"st_nil"</code> or <code>"nil"</code>.

9837

While the first three pseudo kinds will kill existing objects on the given

9838

layer, the last pseudo kind will just do nothing. It is equivalent, but more

9839

expressive than an empty Lua table being used as an object declaration:

9840

9841

<table><tr><td> </td><td><pre class="example">ti["<var>D</var>"] = cond(wo["IsDifficult"], {"st_death"}, {"nil"})

9842

ti["<var>S</var>"] = {"st_surprise", selection={"st_box", "st_nil"}}

9843

function <var>customresolver</var>(<var>key</var>, <var>x</var>, <var>y</var>)

9844

if <var>key</var> == "<var>a</var>" then

9845

return {"nil"}

9846

elseif <var>key</var> == "<var>b</var>" then

9847

return {}

9848

else

9849

return ti[<var>key</var>]

9850

end

9851

end

9852

</pre></td></tr></table>

9853

9854

The first sample uses the pseudo to supply a valid third arguement to the

9855

<a href="#cond">cond</a> function that causes no syntax error when being passed to the

9856

world in easy mode.

9857

9858

The second sample uses the pseudo to kill the <a href="#st_005fsurprise">st_surprise</a> even when

9859

no substitution stone is being set.

9860

9861

The last example of a <a href="#Custom-Resolver">Custom Resolver</a> provides a solution for avoiding

9862

the change of the world on a given key in the world map. Usually you will always

9863

set at least a floor object. But if you draw a map during runtime there is no

9864

longer the need of setting inital floors. In cases where this can not be handled

9865

by proper usage of default keys the pseudo kind <code>"nil"</code> is your friend.

9866

9867

For task driven samples see section <a href="#Tiles-and-World-Tasks">Tiles and World Tasks</a>.

9868

9869

9870

<tr><td align="left" valign="top"><a href="#Tile-concat">5.11.1 Tile concat</a></td><td>  </td><td align="left" valign="top"> Compose a new tile as concatenation of two other

9871

</td></tr>

9872

</table>

9873

9874

9875

9876

9877

9878

9879

9880

9881

9882

9883

9884

9885

9886

9887

9888

9889

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

9890

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

9891

9892

</tr></table>

9893

9894

<h3 class="subsection">5.11.1 Tile concat</h3>

9895

9896

9897

<dt> Syntax:</dt>

9898

<dd>result = tile .. <tile | odecl>

9899

9900

result = <tile | odecl> .. tile

9901

9902

</dd>

9903

<dt> Details:</dt>

9904

<dd>Compose a new tile by concatenation of a tile with another tile or a table

9905

object declaration. In a concatenated chain of tiles and object declarations

9906

one of the first two evaluated arguments needs to be a tile as two Lua tables

9907

do not know how to concat.

9908

9909

Note that Lua does evaluate the ‘<samp>..</samp>’ operator from right to left! Thus you

9910

need either use proper braces or you need to guarantee that at least one of the

9911

two rightmost tokens is a tile.

9912

9913

</dd>

9914

<dt> Syntax Samples:</dt>

9915

<dd><table><tr><td> </td><td><pre class="example"><var>newtile</var> = ti{"st_chess"} .. {"fl_sahara"}

9916

<var>newtile</var> = ti{"st_chess"} .. {"fl_sahara"} .. {"it_cherry"} -- Lua error due to right to left evaluation

9917

<var>newtile</var> = (ti{"st_chess"} .. {"fl_sahara"}) .. {"it_cherry"} -- evaluation order fixed

9918

<var>newtile</var> = ti{"st_chess"} .. {"fl_sahara"} .. ti{"it_cherry"} -- converted one of the two critical declarations

9919

</pre></td></tr></table>

9920

9921

</dd>

9922

</dl>

9923

9924

9925

9926

9927

9928

9929

9930

9931

9932

9933

9934

9935

9936

9937

9938

9939

9940

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

9941

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

9942

9943

</tr></table>

9944

9945

<h2 class="section">5.12 Tiles Repository</h2>

9946

9947

The Tiles datatype is just used by a single instance, the singleton repository of

9948

<a href="#Tile-and-Object-Declaration">Tile and Object Declaration</a>s. Besides the management of tiles it provides

9949

useful conversions of table based object declarations to tiles.

9950

9951

Being a singleton you can not create a new Tiles repository. The singleton is

9952

stored at the global variable ‘<samp>ti</samp>’ on level load.

9953

9954

The repository stores tiles for given string keys. The key strings can be

9955

of any length. Due to Lua limitations they need to be composed of printable

9956

7-bit ASCII characters.

9957

9958

You can assign a tile to every key just once. A reassign causes an error. On

9959

one hand this allows internal implementation optimization, but on the other hand

9960

an unforeseen key reassignment is the most common level coding error that

9961

needs to be reported.

9962

9963

For task driven samples see section <a href="#Tiles-and-World-Tasks">Tiles and World Tasks</a>.

9964

9965

9966

<tr><td align="left" valign="top"><a href="#Tiles-Storage">5.12.1 Tiles Storage</a></td><td>  </td><td align="left" valign="top"> Store a tile for a key

9967

</td></tr>

9968

<tr><td align="left" valign="top"><a href="#Tiles-Request">5.12.2 Tiles Request</a></td><td>  </td><td align="left" valign="top"> Retrieve a tile for a key

9969

</td></tr>

9970

<tr><td align="left" valign="top"><a href="#Tile-Conversion">5.12.3 Tile Conversion</a></td><td>  </td><td align="left" valign="top"> Convert an object declaration into a tile

9971

</td></tr>

9972

</table>

9973

9974

9975

9976

9977

9978

9979

9980

9981

9982

9983

9984

9985

9986

9987

9988

9989

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

9990

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

9991

9992

</tr></table>

9993

9994

<h3 class="subsection">5.12.1 Tiles Storage</h3>

9995

9996

9997

<dt> Syntax:</dt>

9998

9999

10000

</dd>

10001

<dt> Details:</dt>

10002

<dd>Index write accesses to the singleton allows you to assign a tile or an table

10003

based object declaration, that is autoconverted to a tile, to a given key. The

10004

key must be a unique string. Unique in the sense that you can not reassign a

10005

new tile to key to which previously another tile has been assigned.

10006

10007

</dd>

10008

<dt> Syntax Samples:</dt>

10009

10010

ti["<var>$</var>"] = {"st_chess"}

10011

ti["<var>$</var>"] = {"st_switch"} -- error of key reassignment

10012

ti["<var>anykey</var>"] = {"st_chess"}

10013

</pre></td></tr></table>

10014

</dd>

10015

</dl>

10016

10017

10018

10019

10020

10021

10022

10023

10024

10025

10026

10027

10028

10029

10030

10031

10032

10033

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

10034

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

10035

10036

</tr></table>

10037

10038

<h3 class="subsection">5.12.2 Tiles Request</h3>

10039

10040

10041

<dt> Syntax:</dt>

10042

<dd>result = ti["key"]

10043

10044

</dd>

10045

<dt> Details:</dt>

10046

<dd>Request of the tile that has been assigned to the given key. If no tile has yet

10047

been stored for the key a Lua ‘<samp>nil</samp>’ value is returned. Note that this

10048

tiles repository does not use wildcard characters as the named objects and

10049

positions repositories do. The asterisk ‘<samp>*</samp>’ and question mark ‘<samp>?</samp>’ are

10050

just keys as any other characters.

10051

10052

</dd>

10053

<dt> Syntax Samples:</dt>

10054

<dd><table><tr><td> </td><td><pre class="example"><var>tile</var> = ti["<var>#</var>"]

10055

</pre></td></tr></table>

10056

</dd>

10057

</dl>

10058

10059

10060

10061

10062

10063

10064

10065

10066

10067

10068

10069

10070

10071

10072

10073

10074

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

10075

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

10076

10077

</tr></table>

10078

10079

<h3 class="subsection">5.12.3 Tile Conversion</h3>

10080

10081

10082

<dt> Syntax:</dt>

10083

<dd>result = ti(odecl)

10084

10085

</dd>

10086

<dt> Details:</dt>

10087

<dd>Converts a table based object declaration to a new tile value.

10088

10089

</dd>

10090

<dt> Syntax Samples:</dt>

10091

<dd><table><tr><td> </td><td><pre class="example"><var>tile</var> = ti({"st_chess"})

10092

<var>tile</var> = ti{"st_chess"} -- Lua syntax equivalence

10093

</pre></td></tr></table>

10094

</dd>

10095

</dl>

10096

10097

10098

10099

10100

10101

10102

10103

10104

10105

10106

10107

10108

10109

10110

10111

10112

10113

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

10114

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

10115

10116

</tr></table>

10117

10118

<h2 class="section">5.13 World</h2>

10119

10120

The World datatype is just used by a single instance, another singleton object.

10121

A reference to this singleton is stored at the Lua global variable ‘<samp>wo</samp>’ on

10122

level load. Being a singleton you can not instantiate another World object.

10123

10124

But even though the singleton ‘<samp>wo</samp>’ already exists on load of a level the

10125

world is still undefined in all aspects. From the first line of Lua code you

10126

can access the <a href="#Global-Attributes">Global Attributes</a>. But the world gets really set up with

10127

the <a href="#World-Creation">World Creation</a>. After this call the world has a well defined size

10128

and is filled with an initial set of objects that you can access and modify

10129

from this moment on.

10130

10131

10132

<tr><td align="left" valign="top"><a href="#World-Creation">5.13.1 World Creation</a></td><td>  </td><td align="left" valign="top"> Set up world with objects

10133

</td></tr>

10134

<tr><td align="left" valign="top"><a href="#World-Tile-Set">5.13.2 World Tile Set</a></td><td>  </td><td align="left" valign="top"> Index Operator ‘<samp>[]</samp>’ write

10135

</td></tr>

10136

<tr><td align="left" valign="top"><a href="#Global-Attribute-Set">5.13.3 Global Attribute Set</a></td><td>  </td><td align="left" valign="top"> Index Operator ‘<samp>[]</samp>’ write

10137

</td></tr>

10138

<tr><td align="left" valign="top"><a href="#Global-Attribute-Get">5.13.4 Global Attribute Get</a></td><td>  </td><td align="left" valign="top"> Index Operator ‘<samp>[]</samp>’ read

10139

</td></tr>

10140

<tr><td align="left" valign="top"><a href="#add">5.13.5 add</a></td><td>  </td><td align="left" valign="top"> Add single objects to the world or an inventory

10141

</td></tr>

10142

<tr><td align="left" valign="top"><a href="#drawBorder">5.13.6 drawBorder</a></td><td>  </td><td align="left" valign="top"> Draw a rectangular border with a tile

10143

</td></tr>

10144

<tr><td align="left" valign="top"><a href="#drawMap">5.13.7 drawMap</a></td><td>  </td><td align="left" valign="top"> Draw objects given by a map of tile keys

10145

</td></tr>

10146

<tr><td align="left" valign="top"><a href="#drawRect">5.13.8 drawRect</a></td><td>  </td><td align="left" valign="top"> Fill a complete rectangle with a tile

10147

</td></tr>

10148

<tr><td align="left" valign="top"><a href="#world-floor">5.13.9 world floor</a></td><td>  </td><td align="left" valign="top"> Retrieval of floor objects

10149

</td></tr>

10150

<tr><td align="left" valign="top"><a href="#world-item">5.13.10 world item</a></td><td>  </td><td align="left" valign="top"> Retrieval of item objects

10151

</td></tr>

10152

<tr><td align="left" valign="top"><a href="#shuffleOxyd">5.13.11 shuffleOxyd</a></td><td>  </td><td align="left" valign="top"> Oxyd Shuffling Rules

10153

</td></tr>

10154

<tr><td align="left" valign="top"><a href="#world-stone">5.13.12 world stone</a></td><td>  </td><td align="left" valign="top"> Retrieval of stone objects

10155

</td></tr>

10156

</table>

10157

10158

10159

10160

10161

10162

10163

10164

10165

10166

10167

10168

10169

10170

10171

10172

10173

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

10174

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

10175

10176

</tr></table>

10177

10178

<h3 class="subsection">5.13.1 World Creation</h3>

10179

10180

Once all parameters have been set and all tiles have been declared it is time

10181

to create the level world with all its objects. This is done by the following

10182

constructor that appears in three variations.

10183

10184

10185

<dt> Syntax:</dt>

10186

<dd>width, height = wo(topresolver, defaultkey, map)

10187

10188

width, height = wo(topresolver, libmap)

10189

10190

width, height = wo(topresolver, defaultkey, width, height)

10191

10192

10193

<dt> topresolver = <code>ti</code> | resolver | localresolver</dt>

10194

<dd>Every tile in the world is given by a key that needs to be resolved to its

10195

declaration. This can be done either by the <a href="#Tiles-Repository">Tiles Repository</a> ‘<samp>ti</samp>’, or

10196

by given library <a href="#Resolvers">Resolvers</a> or by a local <a href="#Custom-Resolver">Custom Resolver</a> function.

10197

This argument takes the top resolver that is requested first.

10198

</dd>

10199

<dt> defaultkey</dt>

10200

<dd>A string that defines the key that should be taken as default. It is taken

10201

if no other key is given and it is added to a tile if a floor object is

10202

missing. The character length of this key defines the key size within the map

10203

</dd>

10204

10205

<dd>A table of strings. Each string describes a row of tiles by its tile keys.

10206

If a map is given, the world size is determined from the longest string and

10207

the number of rows.

10208

</dd>

10209

<dt> libmap</dt>

10210

<dd>A map of the library <a href="#libmap">libmap</a>

10211

</dd>

10212

<dt> width</dt>

10213

<dd>As an argument that is given instead of a map it describes the width of the

10214

desired world.

10215

</dd>

10216

<dt> height</dt>

10217

<dd>As an argument that is given instead of a map it describes the height of the

10218

desired world.

10219

</dd>

10220

</dl>

10221

10222

</dd>

10223

<dt> Syntax Samples:</dt>

10224

<dd><table><tr><td> </td><td><pre class="example">w, h = wo(ti, " ", 20, 13)

10225

w, h = wo(resolver, " ", {

10226

" ",

10227

...

10228

" "})

10229

w, h = wo(ti, mylibmap)

10230

</pre></td></tr></table>

10231

10232

</dd>

10233

<dt> Details:</dt>

10234

<dd>This world constructor may just be called once. Every subsequent call causes

10235

an error. This call sets the size of the world to fixed values that are reported

10236

by its two return values. The world size can later on be retrieved by the world

10237

attributes <a href="#Width">Width</a> and <a href="#Height">Height</a>, too.

10238

10239

A mapless world is filled with default tiles. Rows in a given map that are

10240

shorter than others are filled with default tiles, too. Any tile that does

10241

not define a floor object will add the floor object of the default tile.

10242

10243

Every key is resolved to its tile declaration via the given resolver chain.

10244

The top resolver is given to this call as a parameter. If it is ‘<samp>ti</samp>’ the

10245

chain consists just of one element and the tile declaration stored in the tiles

10246

repository at the given key is taken. Otherwise the resolvers will be evaluated

10247

as explained in <a href="#Resolver-Chaining">Resolver Chaining</a>.

10248

10249

</dd>

10250

</dl>

10251

10252

10253

10254

10255

10256

10257

10258

10259

10260

10261

10262

10263

10264

10265

10266

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

10267

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

10268

10269

</tr></table>

10270

10271

<h3 class="subsection">5.13.2 World Tile Set</h3>

10272

10273

10274

<dt> Syntax:</dt>

10275

<dd>wo[<object | position | table | group | polist>] = tile_declarations

10276

10277

</dd>

10278

<dt> Details:</dt>

10279

<dd>Index write accesses to an index that can be interpreted as a grid position or

10280

a list of grid positions allows you to set one or several new objects to the

10281

given positions according to the supplied tile declaration.

10282

10283

</dd>

10284

<dt> Syntax Samples:</dt>

10285

<dd><table><tr><td> </td><td><pre class="example">wo[no["<var>myobjectname</var>"]] = {"st_chess"}

10286

wo[po(<var>3</var>, <var>4</var>)] = ti["<var>x</var>"]

10287

wo[{<var>2</var>, <var>5</var>}] = ti["<var>x</var>"] .. ti["<var>y</var>"]

10288

wo[no["<var>floorgroup#*</var>"]] = {"it_burnable_oil"}

10289

wo[no["<var>myobjectname</var>"] + NEIGHBORS_4] = ti["<var>x</var>"]

10290

</pre></td></tr></table>

10291

</dd>

10292

</dl>

10293

10294

10295

10296

10297

10298

10299

10300

10301

10302

10303

10304

10305

10306

10307

10308

10309

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

10310

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

10311

10312

</tr></table>

10313

10314

<h3 class="subsection">5.13.3 Global Attribute Set</h3>

10315

10316

10317

<dt> Syntax:</dt>

10318

<dd>wo["attritbutename"] = value

10319

10320

</dd>

10321

<dt> Details:</dt>

10322

<dd>Write accesses to string type indices allows you to change <a href="#Global-Attributes">Global Attributes</a>.

10323

Just existing attributes with write accessibility may be changed. Note that

10324

some attributes must be set prior <a href="#World-Creation">World Creation</a> to take proper affect.

10325

10326

</dd>

10327

<dt> Syntax Samples:</dt>

10328

<dd><table><tr><td> </td><td><pre class="example">wo["ConserveLevel"] = true

10329

</pre></td></tr></table>

10330

</dd>

10331

</dl>

10332

10333

10334

10335

10336

10337

10338

10339

10340

10341

10342

10343

10344

10345

10346

10347

10348

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

10349

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

10350

10351

</tr></table>

10352

10353

<h3 class="subsection">5.13.4 Global Attribute Get</h3>

10354

10355

10356

<dt> Syntax:</dt>

10357

<dd><var>var</var> = wo["attritbutename"]

10358

10359

</dd>

10360

<dt> Details:</dt>

10361

<dd>Read accesses to string type indices allows you to retrieve <a href="#Global-Attributes">Global Attributes</a>.

10362

Just existing attributes with read accessibility can be read. Note that

10363

some attributes report proper values just after <a href="#World-Creation">World Creation</a>.

10364

10365

</dd>

10366

<dt> Syntax Samples:</dt>

10367

<dd><table><tr><td> </td><td><pre class="example"><var>var</var> = wo["IsDifficult"]

10368

</pre></td></tr></table>

10369

</dd>

10370

</dl>

10371

10372

10373

10374

10375

10376

10377

10378

10379

10380

10381

10382

10383

10384

10385

10386

10387

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

10388

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

10389

10390

</tr></table>

10391

10392

10393

10394

Add <a href="#Other-Objects">Other Objects</a> to the world or a portable item to an inventory or

10395

other container object.

10396

10397

10398

<dt> Syntax:</dt>

10399

<dd>wo:add(tile_declarations)

10400

10401

wo:add(target, tile_declarations)

10402

10403

10404

<dt> tile_declarations</dt>

10405

<dd>One or many other object declarations given as tiles or anonymous tables.

10406

</dd>

10407

<dt> target</dt>

10408

<dd>‘<samp>YIN</samp>’, ‘<samp>YANG</samp>’ or valid <a href="#Object-Reference">Object Reference</a>

10409

</dd>

10410

</dl>

10411

10412

</dd>

10413

<dt> Syntax Samples:</dt>

10414

<dd><table><tr><td> </td><td><pre class="example">wo:add({"ot_rubberband", anchor1="a1", anchor2="w", length=2, strength=80, threshold=0})

10415

wo:add(ti["r"] .. {"ot_wire", anchor1="w1", anchor2="w2"})

10416

wo:add(YIN, {"it_magicwand"})

10417

wo:add(no["mybag"], {"it_magicwand"} .. ti["h"] .. ti["c"])

10418

</pre></td></tr></table>

10419

10420

</dd>

10421

<dt> Details:</dt>

10422

<dd>Just <a href="#Other-Objects">Other Objects</a> can be directly added to the world. Just portable

10423

<a href="#Item-Objects">Item Objects</a> can be added to the player’s inventories ‘<samp>YIN</samp>’ and

10424

‘<samp>YANG</samp>’ and to <a href="#it_005fbag">it_bag</a>s. No other targets do currently add objects by

10425

this method.

10426

10427

</dd>

10428

</dl>

10429

10430

10431

10432

10433

10434

10435

10436

10437

10438

10439

10440

10441

10442

10443

10444

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

10445

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

10446

10447

</tr></table>

10448

10449

<h3 class="subsection">5.13.6 drawBorder</h3>

10450

10451

Draw a border around a rectangle out of given tiles.

10452

10453

10454

<dt> Syntax:</dt>

10455

<dd>wo:drawBorder(upperleft_edge, lowerright_edge, <tile | key, resolver>)

10456

10457

wo:drawBorder(upperleft_edge, width, height, <tile | key, resolver>)

10458

10459

10460

<dt> upperleft_edge</dt>

10461

<dd>Upper left anchor position of the rectangle.

10462

</dd>

10463

<dt> lowerright_edge</dt>

10464

<dd>Lower right end position of the rectangle.

10465

</dd>

10466

<dt> width</dt>

10467

<dd>Width of the rectangle.

10468

</dd>

10469

<dt> height</dt>

10470

<dd>Height of the rectangle.

10471

</dd>

10472

10473

<dd>A tile or an object declaration.

10474

</dd>

10475

10476

<dd>A key string to be resolved via the given resolver.

10477

</dd>

10478

<dt> resolver</dt>

10479

<dd>A resolver to be used for resolving the key to a valid tile.

10480

</dd>

10481

</dl>

10482

10483

</dd>

10484

<dt> Syntax Samples:</dt>

10485

<dd><table><tr><td> </td><td><pre class="example">wo:drawBorder(po(0, 0), wo["Width"], wo["Height"], ti["#"])

10486

wo:drawBorder(no["myRectUL"], no["myRectLR"], {"st_grate1"})

10487

wo:drawBorder(no["myRectUL"], no["myRectLR"], {"fl_water"} .. ti["X"])

10488

wo:drawBorder(no["myRectUL"], no["myRectLR"], "x", myresolver)

10489

</pre></td></tr></table>

10490

10491

</dd>

10492

<dt> Details:</dt>

10493

<dd>The rectangle as four one grid thick lines is drawn with the given tile. That

10494

means on every position of the rectangle itself an instance of every object of

10495

the tile declaration is set. The rectangle may degenerate to a single line.

10496

10497

</dd>

10498

</dl>

10499

10500

10501

10502

10503

10504

10505

10506

10507

10508

10509

10510

10511

10512

10513

10514

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

10515

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

10516

10517

</tr></table>

10518

10519

<h3 class="subsection">5.13.7 drawMap</h3>

10520

10521

Even if the world is initialized by a map on creation of the world

10522

(see section <a href="#World-Creation">World Creation</a>), it is sometime useful to

10523

be able to draw smaller submaps either as part of the initialization or as

10524

dynamic level changes within <a href="#Callback-Function">Callback Function</a>. Of course the main purpose

10525

of ‘<samp>drawMap</samp>’ is the drawing of repeating patterns.

10526

10527

10528

<dt> Syntax:</dt>

10529

<dd>

10530

wo:drawMap(resolver, anchor, ignore, map, [readdir])

10531

10532

wo:drawMap(resolver, anchor, libmap-map, [readdir])

10533

10534

10535

<dt> subresolver</dt>

10536

<dd>Resolver to which unresolved requests should be forwarded. May be ‘<samp>ti</samp>’

10537

as the final resolver of the resolver chain.

10538

</dd>

10539

<dt> anchor</dt>

10540

<dd>The anchor position where the upper left tile of the map should be drawn.

10541

</dd>

10542

<dt> ignore</dt>

10543

<dd>A tile key string that should be ignored. This key string is mandatory, even

10544

if it not used within the map.

10545

</dd>

10546

10547

<dd>A table of strings. Each string describes a row of tiles by its tile keys.

10548

</dd>

10549

<dt> libmap-map</dt>

10550

<dd>If the map used is created via <a href="#libmap">libmap</a>, the ‘<samp>ignore</samp>’-string can

10551

be omitted. The map’s default key will then be ignored instead.

10552

</dd>

10553

<dt> readdir</dt>

10554

<dd>An optional argument to modify the direction of the map relative to the world.

10555

This argument can be any of the constants described in <a href="#Rotating-and-Mirroring-Maps">Rotating and Mirroring Maps</a>.

10556

</dd>

10557

</dl>

10558

10559

</dd>

10560

<dt> Syntax Samples:</dt>

10561

<dd><table><tr><td> </td><td><pre class="example">wo:drawMap(ti, po(5, 7), "-", {"abcabc"})

10562

wo:drawMap(ti, anchor_object, "--", {"--##--##","##--##"})

10563

wo:drawMap(ti, {12, 5}, " ", {"122 221"}, MAP_ROT_CW)

10564

</pre></td></tr></table>

10565

10566

</dd>

10567

<dt> Details:</dt>

10568

<dd>The syntax is similar to the world creation call. But there are two essential

10569

differences you need to be aware of. First the map is drawn in the already

10570

existing world. Thus we need to define the position. This is done via the

10571

anchor position, which can be an already existing object, too.

10572

10573

The second difference is in the definition of a tile key string for tiles in

10574

the map that should be ignored. Remember that the world initialization requested

10575

a default tile key string. This default is still valid. But with the given

10576

ignore key string we can draw arbitrary shaped patterns by filling unused

10577

grids in the map with this key.

10578

10579

The length of the ignore key defines the map key length. It is strongly

10580

recommended to use the same key length as in the world map.

10581

10582

The rows of the supplied map are drawn from the anchor position. The rows may

10583

be of different length and may start with ignore tile keys. The anchor must be

10584

the position composed of the smallest x and smallest y coordinate within the

10585

pattern.

10586

10587

You can use drawMap anywhere after the world creation. You are even allowed to

10588

use it within the world creation in a resolver.

10589

10590

</dd>

10591

<dt> Full Example:</dt>

10592

<dd><table><tr><td> </td><td><pre class="example">01 ti["<var> </var>"] = {"fl_plank"}

10593

02 ti["<var>X</var>"] = {"st_oxyd"}

10594

03 ti["<var>B</var>"] = {"st_passage_black", flavor="<var>frame</var>"}

10595

04 ti["<var>W</var>"] = {"st_passage_white", flavor="<var>frame</var>"}

10596

05 ti["<var>y</var>"] = {"it_yinyang"}

10597

06 ti["<var>1</var>"] = {"#ac_marble_black"}

10598

07 ti["<var>2</var>"] = {"#ac_marble_white"}

10599

08

10600

09 function <var>myresolver</var>(<var>key</var>, <var>x</var>, <var>y</var>)

10601

10 if <var>key</var> == "w" then

10602

11 wo:drawMap(ti, po(x-1, y-1), "-", {"-W-",

10603

12 "WXW",

10604

13 "-W-"})

10605

14 return ti({})

10606

15 elseif <var>key</var> == "b" then

10607

16 wo:drawMap(ti, po(x-1, y-1), "-", {"-B",

10608

17 "BXB",

10609

18 "-B"})

10610

19 return ti({})

10611

20 else

10612

21 return ti[<var>key</var>]

10613

22 end

10614

23 end

10615

24

10616

25 w, h = wo(myresolver, "<var> </var>", {

10617

26 " ",

10618

27 " b b ",

10619

28 " w w ",

10620

29 " ",

10621

30 " ",

10622

31 " w ",

10623

32 " 12 b ",

10624

33 " w ",

10625

34 " w ",

10626

35 " b ",

10627

36 " w b ",

10628

37 " b ",

10629

38 " "

10630

39 })

10631

40 wo:shuffleOxyd()

10632

</pre></td></tr></table>

10633

</dd>

10634

</dl>

10635

10636

10637

10638

10639

10640

10641

10642

10643

10644

10645

10646

10647

10648

10649

10650

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

10651

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

10652

10653

</tr></table>

10654

10655

<h3 class="subsection">5.13.8 drawRect</h3>

10656

10657

Fill a rectangle with a given tile.

10658

10659

10660

<dt> Syntax:</dt>

10661

<dd>wo:drawRect(upperleft_edge, lowerright_edge, <tile | key, resolver>)

10662

10663

wo:drawRect(upperleft_edge, width, height, <tile | key, resolver>)

10664

10665

10666

<dt> upperleft_edge</dt>

10667

<dd>Upper left anchor position of the rectangle.

10668

</dd>

10669

<dt> lowerright_edge</dt>

10670

<dd>Lower right end position of the rectangle.

10671

</dd>

10672

<dt> width</dt>

10673

<dd>Width of the rectangle.

10674

</dd>

10675

<dt> height</dt>

10676

<dd>Height of the rectangle.

10677

</dd>

10678

10679

<dd>A tile or an object declaration.

10680

</dd>

10681

10682

<dd>A key string to be resolved via the given resolver.

10683

</dd>

10684

<dt> resolver</dt>

10685

<dd>A resolver to be used for resolving the key to a valid tile.

10686

</dd>

10687

</dl>

10688

10689

</dd>

10690

<dt> Syntax Samples:</dt>

10691

<dd><table><tr><td> </td><td><pre class="example">wo:drawRect(po(0, 0), wo["Width"], wo["Height"], ti[" "])

10692

wo:drawRect(no["myRectUL"], no["myRectLR"], {"fl_water"})

10693

wo:drawRect(no["myRectUL"], no["myRectLR"], {"fl_water"} .. ti["#"])

10694

wo:drawRect(no["myRectUL"], no["myRectLR"], "x", myresolver)

10695

</pre></td></tr></table>

10696

10697

</dd>

10698

<dt> Details:</dt>

10699

<dd>The complete rectangle is filled with the given tile. That means on every

10700

position of the rectangle and its interior an instance of every object of

10701

the tile declaration is set. The rectangle may degenerate to a single line.

10702

10703

</dd>

10704

</dl>

10705

10706

10707

10708

10709

10710

10711

10712

10713

10714

10715

10716

10717

10718

10719

10720

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

10721

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

10722

10723

</tr></table>

10724

10725

<h3 class="subsection">5.13.9 world floor</h3>

10726

10727

Retrieves the floor objects for the given position or positions.

10728

10729

10730

<dt> Syntax:</dt>

10731

<dd>result = wo:fl(<pos| {x, y}|x, y| obj | group| polist>)

10732

10733

</dd>

10734

<dt> Details:</dt>

10735

<dd>This world method is identical to the global function <a href="#fl">fl</a>.

10736

10737

</dd>

10738

</dl>

10739

10740

10741

10742

10743

10744

10745

10746

10747

10748

10749

10750

10751

10752

10753

10754

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

10755

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

10756

10757

</tr></table>

10758

10759

<h3 class="subsection">5.13.10 world item</h3>

10760

10761

Retrieves the item objects for the given position or positions.

10762

10763

10764

<dt> Syntax:</dt>

10765

<dd>result = wo:it(<pos| {x, y}|x, y| obj | group| polist>)

10766

10767

</dd>

10768

<dt> Details:</dt>

10769

<dd>This world method is identical to the global function <a href="#it">it</a>.

10770

10771

</dd>

10772

</dl>

10773

10774

10775

10776

10777

10778

10779

10780

10781

10782

10783

10784

10785

10786

10787

10788

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

10789

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

10790

10791

</tr></table>

10792

10793

<h3 class="subsection">5.13.11 shuffleOxyd</h3>

10794

10795

Shuffling the color distribution of the <a href="#st_005foxyd">st_oxyd</a> makes every level, that

10796

is no meditation, a bit generic. On every level start the level looks a little

10797

bit different and the user has to solve a modified level. This provides long

10798

term amusement. Thus the call of this method is part of most levels.

10799

10800

Many levels just call this method without any arguments. This results in a

10801

shuffling of all <a href="#st_005foxyd">st_oxyd</a> that are not excluded by a ‘<samp>noshuffle</samp>’

10802

attribute.

10803

10804

But sometimes levels need to influence the shuffling, either for ensuring that

10805

the level remains solvable, or simply to ensure fairness. Imagine a level that

10806

has two <a href="#st_005foxyd">st_oxyd</a>s in every corner. If by chance a user gets a distribution

10807

where he has in each corner a pair of same colored oxyds, the level might be

10808

trivial. Another level may have a passage that the marble can pass just a few

10809

times. With 5 or more oxyds on each side of the passage you need to ensure that

10810

the marble never needs to pass the passage more often than possible. Both

10811

situations can be handled by providing proper rules as arguments to this method.

10812

10813

10814

<dt> Syntax:</dt>

10815

<dd>

10816

wo:shuffleOxyd(rules)

10817

10818

10819

<dt> rules = rule, rule,...</dt>

10820

<dd>No rule or as many as you like, all separated by a comma.

10821

</dd>

10822

<dt> rule = {group1, group2, maxrule, minrule, circularrule, linearrule, log}</dt>

10823

<dd>Each rule is a table with a subset of the listed entries. The group1 entry

10824

is mandatory. All other entries are optional and can be added in any combination.

10825

</dd>

10826

<dt> group1 = group | objectreference | objectspecifier</dt>

10827

<dd>A description of oxyd objects that are part of the first rule group. Either

10828

a group or a single object reference or a string specifier that resolves to a

10829

single or via wildcard to several oxyd objects are legal descriptors.

10830

</dd>

10831

<dt> group2 = group | objectreference | objectspecifier</dt>

10832

<dd>A description of oxyd objects that are part of the second rule group. Either

10833

a group or a single object reference or a string specifier that resolves to a

10834

single or via wildcard to several oxyd objects are legal descriptors.

10835

</dd>

10836

<dt> maxrule = <code>max = </code>number</dt>

10837

<dd>The maximum number of oxyd pairs.

10838

</dd>

10839

<dt> minrule = <code>min = </code>number</dt>

10840

<dd>The minimum number of oxyd pairs.

10841

</dd>

10842

<dt> circularrule = <code>circular = true</code></dt>

10843

<dd>Avoid any pair of neighboring oxyds in group1. Avoid an oxyd pair of first and

10844

last oxyd in group1, too.

10845

</dd>

10846

<dt> linearrule = <code>linear = true</code></dt>

10847

<dd>Avoid any pair of neighboring oxyds in group1.

10848

</dd>

10849

<dt> log = <code>log = </code>    <code>"solution"</code> |<code>"count"</code> |<code>"all"</code></dt>

10850

<dd>Log additional information to the log stream for debugging purposes and

10851

security checks by the level author.

10852

</dd>

10853

</dl>

10854

10855

</dd>

10856

<dt> Syntax Samples:</dt>

10857

<dd><table><tr><td> </td><td><pre class="example">wo:shuffleOxyd()

10858

wo:shuffleOxyd({no["borderoxyds#*"]:sort("circular"), circular=true})

10859

wo:shuffleOxyd({"leftoxyds#*","rightoxyds#*", min=3}, {"islandoxyds#*", max=0})

10860

</pre></td></tr></table>

10861

10862

</dd>

10863

<dt> Details:</dt>

10864

<dd>

10865

Any call of ‘<samp>wo:shuffleOxyd()</samp>’ must occur after all <a href="#st_005foxyd">st_oxyd</a> have been

10866

set. That means that it must follow the standard world initialization

10867

(see section <a href="#World-Creation">World Creation</a>). As a side effect shuffleOxyd

10868

will assign colors to all ‘<samp>OXYD_AUTO</samp>’ colored <a href="#st_005foxyd">st_oxyd</a>.

10869

10870

Once called the given shuffling rules remain valid. Any further reshuffling

10871

must be done by messages ‘<samp>closeall</samp>’ and ‘<samp>shuffle</samp>’ to one arbitrary

10872

<a href="#st_005foxyd">st_oxyd</a> instance. No addition of an <a href="#st_005foxyd">st_oxyd</a> or subsequent

10873

‘<samp>wo:shuffleOxyd()</samp>’ calls are possible without disturbing and deleting the

10874

given rules.

10875

10876

Rule based shuffling is limited to a maximum of one pair of each standard oxyd

10877

color plus any combination of additional special fake, quake or bold oxyds

10878

summing up to a maximum of 32 oxyds. If more than 32 oxyds or 2 or more pairs

10879

of a single standard color are set, all oxyds will be shuffled by random

10880

ignoring any provided rules.

10881

10882

There are basically two different types of rules. Those with one group and those

10883

with two groups of oxyds (Note that group is the general API expression for

10884

a set of oxyds and not a mathematical group). For a single group the rules apply

10885

to the oxyd instances within this group. For two groups the rules apply to oxyd

10886

pairs with one oxyd in the first group and the other in the second group.

10887

10888

E.g. ‘<samp>{"islandoxyds#*", max=0}</samp>’ requests that there is no pair within

10889

this group of oxyds. Whereas ‘<samp>{"leftoxyds#*","rightoxyds#*", min=3}</samp>’

10890

requests that there are 3 different oxyd pairs, each with one oxyd out of the

10891

leftoxyd group and the second out of the rightoxyd group.

10892

10893

Linear and circular rules can only be applied to a single group. They are

10894

shortcuts for the most common rules that are applied to oxyds arranged on a

10895

line or a circle. In both cases they avoid pairs of neighboring oxyds. They

10896

are equivalent to ‘<samp>n-1</samp>’ res. ‘<samp>n</samp>’ rules with all possible neighboring

10897

oxyd pairs as two groups and a rule of ‘<samp>max=0</samp>’.

10898

10899

Note that you can apply several rules at once to given groups. E.g. you can

10900

apply a minrule and a maxrule within one rule!

10901

10902

The shuffling process consists always of two stages. The most important first

10903

stage generates a valid oxyd pair distribution. That means that we settle which

10904

pairs will have the same color. But the color itself is assigned in an

10905

independent second stage. As for the examination of given rules just the pair

10906

distribution is relevant, we do just count and log these different distributions

10907

ignoring the colors.

10908

10909

With 16 oxyds of 8 different colors and no restricting rules you have 2027025

10910

(15 * 13 * 11 * 9 * 7 * 5 * 3) different valid distributions. Keep in mind

10911

that useful rules should always keep hundreds or thousands of different valid

10912

distributions for a level.

10913

10914

For debugging purposes you can add a log parameter to one of the rules (it does

10915

not matter to which one). If you request the log of ‘<samp>solution</samp>’ the

10916

pair distribution will be printed to the log stream.

10917

10918

In case of ‘<samp>count</samp>’ the number of different oxyd distributions will be

10919

counted and logged. It is recommended to check the count on complex rules to

10920

ensure that enough distributions remain for a varying game. But be careful

10921

applying count on trivial rules. With 16 oxyds there may be as many as

10922

2027025 distributions and it may take a standard PC up to 30 seconds to count

10923

them - add a factor of 17*19 for 20 oxyds!

10924

10925

Be very, very cautious in usage of logging ‘<samp>all</samp>’. This call tries to print

10926

all solutions. It takes ages if there are too many solutions. First check the

10927

count before trying to log the solutions.

10928

10929

</dd>

10930

<dt> Full Example:</dt>

10931

<dd><table><tr><td> </td><td><pre class="example">01 wo["ConserveLevel"] = <var>false</var>

10932

02

10933

03 ti["<var>~</var>"] = {"fl_water"}

10934

04 ti["<var> </var>"] = {"fl_plank"}

10935

05 ti["<var>c</var>"] = {"it_crack_l", brittleness=<var>0</var>}

10936

06 ti["<var>^</var>"] = {"st_oneway_n"}

10937

07 ti["<var>1</var>"] = {"ac_marble_black", 0, 0.5}

10938

08

10939

09 ti["<var>x</var>"] = {"st_oxyd", "island#"}

10940

10 ti["<var>y</var>"] = {"st_oxyd", "left#"}

10941

11 ti["<var>z</var>"] = {"st_oxyd", "right#"}

10942

12

10943

13 w, h = wo(ti, "<var> </var>", {

10944

14 "<var>~~x x x x x x~~</var>",

10945

15 "<var>~~ ~~</var>",

10946

16 "<var>~~~~^~~~~~~~~~~^~~~~</var>",

10947

17 "<var>y ~~~~ z</var>",

10948

18 "<var>~ cccc ~</var>",

10949

19 "<var>y ~~~~ z</var>",

10950

20 "<var>~ cccc ~</var>",

10951

21 "<var>y ~~~~ z</var>",

10952

22 "<var>~ cccc ~</var>",

10953

23 "<var>y ~~~~ z</var>",

10954

24 "<var>~~~~c~~~~~~~~~~c~~~~</var>",

10955

25 "<var>~~ ~~</var>",

10956

26 "<var>~~ 1 ~~</var>"

10957

27 })

10958

28

10959

29 wo:shuffleOxyd({"island#*", min=<var>3</var>, linear=<var>true</var>}, {"left#*","right#*", max=<var>2</var>, min=<var>2</var>})

10960

</pre></td></tr></table>

10961

10962

This level uses 14 oxyds. The 6 oxyds in the upper row are on an island that

10963

can not be left once the marble entered it through one of the oneways. Thus

10964

we need 3 pairs of oxyds on this island, which are enforced by the min rule.

10965

To avoid trivial neighboring pairs on the island, we do add a linear rule, too.

10966

The marble can pass just three times between the left and right islands. This

10967

allows a first look on the color oxyds with one pass and opening one pair on

10968

each of the two following passes. Thus we limit the number of pairs by a max

10969

rule to 2. To avoid trivial oxyd pair distributions, like two pairs on the left

10970

and two pairs on the right side, we do add a min rule that enforces that two

10971

shared pairs of oxyds do exist.

10972

</dd>

10973

</dl>

10974

10975

10976

10977

10978

10979

10980

10981

10982

10983

10984

10985

10986

10987

10988

10989

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

10990

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

10991

10992

</tr></table>

10993

10994

<h3 class="subsection">5.13.12 world stone</h3>

10995

10996

Retrieves the stone objects for the given position or positions.

10997

10998

10999

<dt> Syntax:</dt>

11000

<dd>result = wo:st(<pos| {x, y}|x, y| obj | group| polist>)

11001

11002

</dd>

11003

<dt> Details:</dt>

11004

<dd>This world method is identical to the global function <a href="#st">st</a>.

11005

11006

</dd>

11007

</dl>

11008

11009

11010

11011

11012

11013

11014

11015

11016

11017

11018

11019

11020

11021

11022

11023

11024

11025

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

11026

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

11027

11028

</tr></table>

11029

11030

<h2 class="section">5.14 Functions</h2>

11031

11032

Besides all the features strongly related to a value as context and thus

11033

implemented as operators or methods of these datatypes, a few other tasks

11034

remain. These are either context free or take at least in one variation just a

11035

standard Lua datatype, that does not supply a context. Thus these tasks are

11036

implemented as simple functions.

11037

11038

11039

<tr><td align="left" valign="top"><a href="#assert_005fbool">5.14.1 assert_bool</a></td><td>  </td><td align="left" valign="top"> Throws an error if a condition doesn’t hold.

11040

</td></tr>

11041

<tr><td align="left" valign="top"><a href="#assert_005ftype">5.14.2 assert_type</a></td><td>  </td><td align="left" valign="top"> Throws an error if a variable is not of a given type.

11042

</td></tr>

11043

<tr><td align="left" valign="top"><a href="#cond">5.14.3 cond</a></td><td>  </td><td align="left" valign="top"> A ternary operator, wrapper for if-then-else.

11044

</td></tr>

11045

<tr><td align="left" valign="top"><a href="#etype">5.14.4 etype</a></td><td>  </td><td align="left" valign="top"> An advanced function to return normal and user data types.

11046

</td></tr>

11047

<tr><td align="left" valign="top"><a href="#fl">5.14.5 fl</a></td><td>  </td><td align="left" valign="top"> Floor retrieval

11048

</td></tr>

11049

<tr><td align="left" valign="top"><a href="#grp">5.14.6 grp</a></td><td>  </td><td align="left" valign="top"> Create a group out of the argument objects

11050

</td></tr>

11051

<tr><td align="left" valign="top"><a href="#it">5.14.7 it</a></td><td>  </td><td align="left" valign="top"> Item retrieval

11052

</td></tr>

11053

<tr><td align="left" valign="top"><a href="#ORI2DIR">5.14.8 ORI2DIR</a></td><td>  </td><td align="left" valign="top"> Orientation to direction conversion

11054

</td></tr>

11055

<tr><td align="left" valign="top"><a href="#random">5.14.9 random</a></td><td>  </td><td align="left" valign="top"> Random number generator

11056

</td></tr>

11057

<tr><td align="left" valign="top"><a href="#st">5.14.10 st</a></td><td>  </td><td align="left" valign="top"> Stone retrieval

11058

</td></tr>

11059

<tr><td align="left" valign="top"><a href="#usertype">5.14.11 usertype</a></td><td>  </td><td align="left" valign="top"> Type info for Enigma userdata types

11060

</td></tr>

11061

</table>

11062

11063

11064

11065

11066

11067

11068

11069

11070

11071

11072

11073

11074

11075

11076

11077

11078

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

11079

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

11080

11081

</tr></table>

11082

11083

<h3 class="subsection">5.14.1 assert_bool</h3>

11084

11085

11086

The function ‘<samp>assert_bool</samp>’ throws an error if a given condition doesn’t hold.

11087

11088

11089

<dt> Syntax:</dt>

11090

<dd>assert_bool(condition, message, level)

11091

11092

11093

<dt> condition</dt>

11094

<dd>A boolean expression or anything else. If it is <code>false</code> or <code>nil</code>, an

11095

error will be thrown.

11096

11097

</dd>

11098

<dt> message</dt>

11099

<dd>A string, holding the error message. If <code>message</code> is nil or empty, an

11100

"anonymous assertion" will be thrown, but it’s always better to provide a

11101

meaningful error message.

11102

11103

</dd>

11104

<dt> level</dt>

11105

<dd><code>level</code> specifies the error position in the same way as does Lua’s

11106

‘<samp>error</samp>’-function. Default is 1.

11107

</dd>

11108

</dl>

11109

11110

</dd>

11111

<dt> Syntax Samples:</dt>

11112

<dd><table><tr><td> </td><td><pre class="example">assert_bool(no["<var>mystone</var>"]:exists(), "<var>Stone 'mystone' has disappeared.</var>")

11113

</pre></td></tr></table>

11114

11115

</dd>

11116

<dt> Details:</dt>

11117

<dd>Assertions help you to detect coding errors. They are heavily used on argument

11118

checks of library functions and resolver implementations. As the assertions

11119

should not lead to performance penalties during runtime they are usually just

11120

evaluated when the level’s ‘<samp>status</samp>’ is declared in the XML header element

11121

<a href="#g_t_003cversion_003e"><version></a> with a value of either <code>"test"</code> or <code>"experimental"</code>.

11122

11123

For <code>"stable"</code> and <code>"released"</code> levels standard assert statements are

11124

simply skipped on compilation like Lua comments. But you can enforce assert

11125

statements to be executed even in these modes by the following pattern of

11126

assignment and additional braces:

11127

<table><tr><td> </td><td><pre class="example"><var>dummy</var> = (assert_bool)(no["<var>mystone</var>"]:exists(), "<var>Stone 'mystone' has disappeared.</var>")

11128

</pre></td></tr></table>

11129

11130

Similar to <a href="#cond">cond</a>, all side effects within the evaluation of ‘<samp>message</samp>’

11131

and ‘<samp>level</samp>’ will appear.

11132

11133

See Lua’s manual for more detailed information about the ‘<samp>error</samp>’-function.

11134

11135

</dd>

11136

</dl>

11137

11138

11139

11140

11141

11142

11143

11144

11145

11146

11147

11148

11149

11150

11151

11152

11153

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

11154

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

11155

11156

</tr></table>

11157

11158

<h3 class="subsection">5.14.2 assert_type</h3>

11159

11160

11161

The function ‘<samp>assert_type</samp>’ throws an error if the first argument is not of one of the

11162

specified types.

11163

11164

11165

<dt> Syntax:</dt>

11166

<dd>assert_type(var, vardescription, level, type1, type2, ...)

11167

11168

11169

11170

<dd>Any kind of variable.

11171

11172

</dd>

11173

<dt> vardescription</dt>

11174

<dd>If ‘<samp>var</samp>’ is not of one of the types ‘<samp>type1</samp>’, ‘<samp>type2</samp>’ ...,

11175

then an error message will be thrown which includes the actual type of

11176

‘<samp>var</samp>’ and the desired types. ‘<samp>vardescription</samp>’ is a string which

11177

holds additional information for the error message. It should be a lower-case

11178

not-too-short description of ‘<samp>var</samp>’ (a name, as it is), additional

11179

details should be added in brackets.

11180

11181

</dd>

11182

<dt> level</dt>

11183

<dd><code>level</code> specifies the error position in the same way as does Lua’s

11184

‘<samp>error</samp>’-function. Can’t be omitted, use ‘<samp>1</samp>’ if in doubt.

11185

11186

</dd>

11187

11188

<dd>A sequence of strings. If ‘<samp>var</samp>’ is none of these types, the error will

11189

be thrown. See details below for type descriptors.

11190

</dd>

11191

</dl>

11192

11193

</dd>

11194

<dt> Syntax Samples:</dt>

11195

<dd><table><tr><td> </td><td><pre class="example">assert_type(<var>arg1</var>, "<var>mygreatfunction first argument (level width)</var>", <var>1</var>, "nil", "positive integer", "position")

11196

</pre></td></tr></table>

11197

11198

</dd>

11199

<dt> Details:</dt>

11200

<dd>Assertions help you to detect coding errors. They are heavily used on argument

11201

checks of library functions and resolver implementations. As the assertions

11202

should not lead to performance penalties during runtime they are usually just

11203

evaluated when the level’s ‘<samp>status</samp>’ is declared in the XML header element

11204

<a href="#g_t_003cversion_003e"><version></a> with a value of either <code>"test"</code> or <code>"experimental"</code>.

11205

11206

For <code>"stable"</code> and <code>"released"</code> levels standard assert statements are

11207

simply skipped on compilation like Lua comments. But you can enforce assert

11208

statements to be executed even in these modes by the following pattern of

11209

assignment and additional braces:

11210

<table><tr><td> </td><td><pre class="example"><var>dummy</var> = (assert_type)(<var>arg1</var>, "<var>myfunction first argument</var>", <var>1</var>, "integer")

11211

</pre></td></tr></table>

11212

11213

Possible types are all Lua types (like <code>"nil"</code>, <code>"number"</code>,

11214

<code>"boolean"</code>, <code>"string"</code>, <code>"table"</code>, <code>"function"</code>) except

11215

<code>"userdata"</code>, all Enigma-own user types (<code>"object"</code>,

11216

<code>"position"</code>, <code>"tile"</code>, <code>"tiles"</code>, <code>"group"</code>,

11217

<code>"world"</code>, <code>"polist"</code>, <code>"unknown"</code>), and

11218

types defined inside metatables (<code>"map"</code> from <a href="#libmap">libmap</a>), see

11219

<a href="#etype">etype</a>. In addition, the following type descriptors are recognized:

11220

11221

<dt> <code>"integer"</code></dt>

11222

<dd>Any integer number (..., -2, -1, 0, 1, 2, ...)

11223

</dd>

11224

<dt> <code>"positive"</code></dt>

11225

<dd>Any number which is positive and not zero.

11226

</dd>

11227

<dt> <code>"non-negative"</code></dt>

11228

<dd>Any number which is not negative, i.e. which is positive or zero.

11229

</dd>

11230

<dt> <code>"natural"</code></dt>

11231

<dd>Any non-negative integer number (0, 1, 2, ...).

11232

</dd>

11233

<dt> <code>"positive integer"</code></dt>

11234

<dd>Any positive integer number (1, 2, 3, ...).

11235

</dd>

11236

<dt> <code>"non-empty string"</code></dt>

11237

<dd>Any string other than the empty string <code>""</code>.

11238

</dd>

11239

<dt> <code>"any table"</code></dt>

11240

<dd>If ‘<samp>var</samp>’ is a table, the ‘<samp>_type</samp>’-attribute of its metatable will

11241

be used as its <a href="#etype">etype</a>. In particular, it won’t be accepted as a

11242

<code>"table"</code> anymore, if this ‘<samp>_type</samp>’-attribute exists. For example,

11243

<table><tr><td> </td><td><pre class="example">assert_type(mytable, "large table", 1, "table")

11244

</pre></td></tr></table>

11245

will throw an assertion when ‘<samp>mytable</samp>’ is a <code>"map"</code>, although,

11246

technically, a <code>"map"</code> always is a <code>"table"</code>. You can use

11247

<code>"any table"</code> as type to allow for any table, regardless of its metatable.

11248

</dd>

11249

<dt> <code>"valid object"</code></dt>

11250

<dd>Any valid object.

11251

</dd>

11252

</dl>

11253

11254

Similar to <a href="#cond">cond</a>, all side effects within the evaluation of

11255

‘<samp>vardescription</samp>’, ‘<samp>level</samp>’ and any type descriptor will apply.

11256

11257

See Lua’s manual for more detailed information about the ‘<samp>error</samp>’-function.

11258

11259

</dd>

11260

<dt> Full Example:</dt>

11261

<dd><table><tr><td> </td><td><pre class="example">function paint_lawn(pos)

11262

assert_type(pos, "paint_lawn first argument", 2, "position", "object", "polist", "group", "table")

11263

if etype(pos) == "object" then

11264

assert_bool(-pos, "paint_lawn: Object not existing.", 2)

11265

end

11266

wo[pos] = ti["lawn"]

11267

end

11268

paint_lawn(no["mystone"])

11269

paint_lawn("myotherstone")

11270

</pre></td></tr></table>

11271

If ‘<samp>mystone</samp>’ doesn’t exist, <code>no["mystone"]</code> will still be of etype

11272

<code>"object"</code>, an invalid object. Hence <code>assert_type</code> will not trigger,

11273

but <code>assert_bool</code> will.

11274

11275

If ‘<samp>mystone</samp>’ exists, the second ‘<samp>paint_lawn</samp>’ will throw an error via

11276

‘<samp>assert_type</samp>’, as <code>pos</code> now is a <code>"string"</code>. The error message

11277

will be:

11278

<table><tr><td> </td><td><pre class="example">Wrong type for paint_lawn first argument, is string, must be one of position,

11279

object, polist, group, table.

11280

</pre></td></tr></table>

11281

</dd>

11282

</dl>

11283

11284

11285

11286

11287

11288

11289

11290

11291

11292

11293

11294

11295

11296

11297

11298

11299

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

11300

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

11301

11302

</tr></table>

11303

11304

11305

11306

‘<samp>cond</samp>’ is a conditional assignment, a substitution for the ternary

11307

‘<samp>?:</samp>’ operator of C-like languages. Note however, that it is not an

11308

equivalent substitution but just a workaround with some subtle side effects.

11309

11310

11311

<dt> Syntax:</dt>

11312

<dd>cond(condition, iftrue, iffalse)

11313

11314

11315

<dt> condition</dt>

11316

<dd>A boolean expression.

11317

11318

</dd>

11319

<dt> iftrue</dt>

11320

<dd>The expression to be returned if ‘<samp>condition</samp>’ is true.

11321

11322

</dd>

11323

<dt> iffalse</dt>

11324

<dd>The expression to be returned if ‘<samp>condition</samp>’ is false.

11325

</dd>

11326

</dl>

11327

11328

</dd>

11329

<dt> Syntax Samples:</dt>

11330

<dd><table><tr><td> </td><td><pre class="example">ti["<var>x</var>"] = cond(wo["IsDifficult"], {"st_death"}, ti["<var>#</var>"])

11331

ti["<var>D</var>"] = cond(wo["IsDifficult"], {"st_death"}, {"nil"})

11332

</pre></td></tr></table>

11333

11334

</dd>

11335

<dt> Details:</dt>

11336

<dd>‘<samp>cond</samp>’ always evaluates both expressions ‘<samp>iftrue</samp>’ and

11337

‘<samp>iffalse</samp>’, regardless of ‘<samp>condition</samp>’. Hence,

11338

<table><tr><td> </td><td><pre class="example"><var>mytable</var> = {<var>1</var>,<var>2</var>,<var>3</var>,<var>4</var>,<var>5</var>,<var>6</var>,<var>7</var>,<var>8</var>,<var>9</var>,<var>0</var>}

11339

<var>removed_element</var> = cond(<var>i</var> < <var>5</var>, table.remove(<var>mytable</var>, <var>i</var>), table.remove(<var>mytable</var>, <var>5</var>))

11340

</pre></td></tr></table>

11341

will always remove two elements. With ‘<samp>i=2</samp>’ the ‘<samp>2</samp>’ will be returned

11342

but ‘<samp>mytable</samp>’ will result in ‘<samp>{1,3,4,5,7,8,9,0}</samp>’, and with ‘<samp>i=6</samp>’

11343

you get the ‘<samp>5</samp>’ but mytable will be ‘<samp>{1,2,3,4,7,8,9,0}</samp>’.

11344

11345

Another Enigma example that will cause errors is:

11346

<table><tr><td> </td><td><pre class="example"><var>w</var>,<var>h</var> = cond(wo["IsDifficult"], wo(ti, " ", <var>map1</var>), wo(ti, " ", <var>map2</var>))

11347

</pre></td></tr></table>

11348

Both, the second and the third argument will be evaluated. Thus two contradicting

11349

attempts to create a new world will be made causing the second one to fail. Use

11350

the following statement instead:

11351

<table><tr><td> </td><td><pre class="example"><var>w</var>,<var>h</var> = wo(ti, " ", cond(wo["IsDifficult"], <var>map1</var>, <var>map2</var>))

11352

</pre></td></tr></table>

11353

However, in most cases ‘<samp>cond</samp>’ is used anyway with static expressions for

11354

‘<samp>iftrue</samp>’ and ‘<samp>iffalse</samp>’ (e.g. strings or variables) and no side effects

11355

will occur.

11356

11357

</dd>

11358

</dl>

11359

11360

11361

11362

11363

11364

11365

11366

11367

11368

11369

11370

11371

11372

11373

11374

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

11375

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

11376

11377

</tr></table>

11378

11379

<h3 class="subsection">5.14.4 etype</h3>

11380

11381

11382

The function ‘<samp>etype()</samp>’ returns the advanced type of its argument.

11383

11384

11385

<dt> Syntax:</dt>

11386

<dd>etype(var)

11387

11388

11389

11390

<dd>Any kind of variable.

11391

</dd>

11392

</dl>

11393

11394

</dd>

11395

<dt> Syntax Samples:</dt>

11396

<dd><table><tr><td> </td><td><pre class="example"><var>argtype</var> = etype(<var>value</var>)

11397

</pre></td></tr></table>

11398

11399

</dd>

11400

<dt> Details:</dt>

11401

<dd>Lua types are <code>"nil"</code>, <code>"number"</code>, <code>"boolean"</code>, <code>"string"</code>,

11402

<code>"table"</code>, <code>"function"</code>, <code>"userdata"</code>, and <code>"thread"</code>. You

11403

can use Lua’s ‘<samp>type</samp>’-function to query the type of any variable. However,

11404

Enigma defines more types through various means, and these types can be queried

11405

via ‘<samp>etype</samp>’. ‘<samp>etype</samp>’ will return its argument’s Lua type as usual,

11406

with the following two exceptions:

11407

11408

<dt> "userdata"</dt>

11409

<dd>Instead of <code>"userdata"</code>, Enigma’s special types will be returned. These

11410

special types are <code>"object"</code>, <code>"position"</code>, <code>"tile"</code>,

11411

<code>"tiles"</code>, <code>"group"</code>, <code>"world"</code>, <code>"polist"</code> and

11412

<code>"default"</code>. If an unknown userdata is encountered, <code>"unknown"</code> will

11413

be returned.

11414

11415

</dd>

11416

<dt> "table"</dt>

11417

<dd>If <code>var</code> is a table, its metatable will be queried. If there is an entry

11418

‘<samp>_type</samp>’, this entry will be used as <code>etype</code>. Most important examples

11419

of this kind are <a href="#libmap">libmap</a>-maps, <a href="#Resolvers">Resolvers</a> and <a href="#res_002emaze">res.maze</a> with its

11420

mazes and cells. So ‘<samp>etype</samp>’ will return <code>"map"</code>, <code>"resolver"</code>,

11421

<code>"maze"</code> and <code>"cell"</code>, too. You may access the <code>etype</code>-system

11422

through ‘<samp>_type</samp>’ whenever you use metatables on your own.

11423

</dd>

11424

</dl>

11425

11426

</dd>

11427

</dl>

11428

11429

11430

11431

11432

11433

11434

11435

11436

11437

11438

11439

11440

11441

11442

11443

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

11444

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

11445

11446

</tr></table>

11447

11448

11449

11450

11451

The function ‘<samp>fl()</samp>’ retrieves the floor objects for the given position or

11452

positions.

11453

11454

11455

<dt> Syntax:</dt>

11456

<dd>result = fl(<pos| {x, y}|x, y| obj | group| polist>)

11457

11458

</dd>

11459

<dt> Details:</dt>

11460

<dd>If the argument describes a single position, the floor object at this position

11461

is returned. When this single position is outside of the world an invalid

11462

‘<samp>NULL</samp>’ <a href="#Object">Object</a> reference is returned.

11463

11464

If the argument is either a <a href="#Group">Group</a> or <a href="#PositionList">PositionList</a> all floor objects

11465

of the related positions are retrieved and added in the same sequence to a new

11466

result group. Invalid positions will be skipped without adding an object to the

11467

group.

11468

11469

In any case you can send messages to the result value.

11470

11471

</dd>

11472

<dt> Syntax Samples:</dt>

11473

<dd><table><tr><td> </td><td><pre class="example"><var>floor</var> = fl(po(<var>3</var>, <var>5</var>))

11474

<var>floor</var> = fl({<var>3</var>, <var>5</var>})

11475

<var>floor</var> = fl(<var>3</var>, <var>5</var>)

11476

<var>floor</var> = fl{<var>3</var>, <var>5</var>} -- by Lua syntax equivalence

11477

<var>floor</var> = fl(<var>mystone</var>)

11478

<var>group</var> = fl(no["door#*"])

11479

<var>group</var> = fl(po(<var>3</var>, <var>5</var>)..po(<var>4</var>, <var>2</var>))

11480

</pre></td></tr></table>

11481

11482

</dd>

11483

</dl>

11484

11485

11486

11487

11488

11489

11490

11491

11492

11493

11494

11495

11496

11497

11498

11499

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

11500

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

11501

11502

</tr></table>

11503

11504

11505

11506

11507

The function ‘<samp>grp()</samp>’ builds a <a href="#Group">Group</a> out of its argument <a href="#Object">Object</a>s.

11508

11509

11510

<dt> Syntax:</dt>

11511

<dd>grp(<{obj1,obj2,...}| obj1,obj2,... |group>)

11512

11513

</dd>

11514

<dt> Details:</dt>

11515

<dd>Returns a new <a href="#Group">Group</a> that is build up by the objects listed by the

11516

arguments. The contents objects must be either listed in a Lua table, given

11517

as multiple single object arguments or an existing group. In all cases the

11518

sequence of objects is maintained in the returned new group, but all invalid

11519

‘<samp>NULL</samp>’ objects are omitted. In case one object is listed multiple times

11520

just the first instance will occur in the group and subsequent instances will

11521

be omitted.

11522

11523

</dd>

11524

<dt> Syntax Samples:</dt>

11525

<dd><table><tr><td> </td><td><pre class="example"><var>newgroup</var> = grp(<var>obj1</var>, <var>obj2</var>, <var>obj3</var>)

11526

<var>newgroup</var> = grp({<var>obj1</var>,<var>obj2</var>})

11527

<var>newgroup</var> = grp{<var>obj1</var>,<var>obj2</var>} -- Lua syntax equivalence

11528

<var>newgroup</var> = grp{} -- empty group

11529

<var>newgroup</var> = grp(<var>group</var>) -- a copy of group cleaned of invalid ‘<samp>NULL</samp>’ objects

11530

</pre></td></tr></table>

11531

11532

</dd>

11533

</dl>

11534

11535

11536

11537

11538

11539

11540

11541

11542

11543

11544

11545

11546

11547

11548

11549

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

11550

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

11551

11552

</tr></table>

11553

11554

11555

11556

11557

The function ‘<samp>it()</samp>’ retrieves the item objects for the given position or

11558

positions.

11559

11560

11561

<dt> Syntax:</dt>

11562

<dd>result = it(<pos| {x, y}|x, y| obj | group| polist>)

11563

11564

</dd>

11565

<dt> Details:</dt>

11566

<dd>If the argument describes a single position, the item object at this position

11567

is returned. When no item is located at the given single position or this

11568

position is outside of the world an invalid ‘<samp>NULL</samp>’ <a href="#Object">Object</a> reference

11569

is returned.

11570

11571

If the argument is either a <a href="#Group">Group</a> or <a href="#PositionList">PositionList</a> all item objects

11572

of the related positions are retrieved and added in the same sequence to a new

11573

result group. Invalid positions or positions without items will be skipped

11574

without adding an object to the group.

11575

11576

In any case you can send messages to the result value.

11577

11578

</dd>

11579

<dt> Syntax Samples:</dt>

11580

<dd><table><tr><td> </td><td><pre class="example"><var>item</var> = it(po(<var>3</var>, <var>5</var>))

11581

<var>item</var> = it({<var>3</var>, <var>5</var>})

11582

<var>item</var> = it(<var>3</var>, <var>5</var>)

11583

<var>item</var> = it{<var>3</var>, <var>5</var>} -- by Lua syntax equivalence

11584

<var>item</var> = it(<var>mystone</var>)

11585

<var>group</var> = it(no["door#*"])

11586

<var>group</var> = it(po(<var>3</var>, <var>5</var>)..po(<var>4</var>, <var>2</var>))

11587

</pre></td></tr></table>

11588

11589

</dd>

11590

</dl>

11591

11592

11593

11594

11595

11596

11597

11598

11599

11600

11601

11602

11603

11604

11605

11606

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

11607

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

11608

11609

</tr></table>

11610

11611

11612

11613

The table ‘<samp>ORI2DIR[]</samp>’ converts orientation values to direction values.

11614

11615

11616

<dt> Syntax:</dt>

11617

<dd>result = ORI2DIR[<var>orientation</var>]

11618

11619

</dd>

11620

<dt> Details:</dt>

11621

<dd>The table has stored the proper directions values at the index positions of

11622

the related orientations.

11623

11624

</dd>

11625

<dt> Syntax Samples:</dt>

11626

<dd><table><tr><td> </td><td><pre class="example"><var>direction</var> = ORI2DIR[NORTH] -- N = po(0, -1)

11627

<var>direction</var> = ORI2DIR[SOUTHEAST] -- SE = po(1, 1)

11628

<var>direction</var> = ORI2DIR[NODIR] -- po(0, 0)

11629

</pre></td></tr></table>

11630

11631

</dd>

11632

</dl>

11633

11634

11635

11636

11637

11638

11639

11640

11641

11642

11643

11644

11645

11646

11647

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

11648

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

11649

11650

</tr></table>

11651

11652

<h3 class="subsection">5.14.9 random</h3>

11653

11654

11655

The function ‘<samp>random()</samp>’ is a syntax compatible replacement for the standard

11656

Lua function ‘<samp>math.random()</samp>’. Both names refer to the same Enigma random

11657

implementation.

11658

11659

11660

<dt> Syntax:</dt>

11661

<dd>result = random(<|<var>n</var>|<var>l</var>,<var>u</var>>)

11662

11663

</dd>

11664

<dt> Details:</dt>

11665

<dd>When called without arguments, math.random returns a pseudo-random real number

11666

in the range [0,1). When called with a number n, math.random returns a

11667

pseudo-random integer in the range [1,n]. When called with two arguments, l and

11668

u, math.random returns a pseudo-random integer in the range [l,u].

11669

11670

The only difference from the Lua implementation is the random generator itself.

11671

Enigma uses an own implementation that guarantees the same pseudo-random

11672

number sequence on any operating system and any processor for a given seed.

11673

This feature will be important for future Enigma versions and thus the

11674

randomseed can not be modified by the level itself.

11675

11676

</dd>

11677

<dt> Syntax Samples:</dt>

11678

<dd><table><tr><td> </td><td><pre class="example"><var>float</var> = random() -- e.g. 0.402834

11679

<var>integer</var> = random(20) -- e.g. 13

11680

<var>integer</var> = random(5, 10) -- e.g. 5

11681

</pre></td></tr></table>

11682

11683

</dd>

11684

</dl>

11685

11686

11687

11688

11689

11690

11691

11692

11693

11694

11695

11696

11697

11698

11699

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

11700

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

11701

11702

</tr></table>

11703

11704

11705

11706

11707

The function ‘<samp>st()</samp>’ retrieves the stone objects for the given position or

11708

positions.

11709

11710

11711

<dt> Syntax:</dt>

11712

<dd>result = st(<pos| {x, y}|x, y| obj | group| polist>)

11713

11714

</dd>

11715

<dt> Details:</dt>

11716

<dd>If the argument describes a single position, the stone object at this position

11717

is returned. When no stone is located at the given single position or this

11718

position is outside of the world an invalid ‘<samp>NULL</samp>’ <a href="#Object">Object</a> reference

11719

is returned.

11720

11721

If the argument is either a <a href="#Group">Group</a> or <a href="#PositionList">PositionList</a> all stone objects

11722

of the related positions are retrieved and added in the same sequence to a new

11723

result group. Invalid positions or positions without stone will be skipped

11724

without adding an object to the group.

11725

11726

In any case you can send messages to the result value.

11727

11728

</dd>

11729

<dt> Syntax Samples:</dt>

11730

<dd><table><tr><td> </td><td><pre class="example"><var>stone</var> = st(po(<var>3</var>, <var>5</var>))

11731

<var>stone</var> = st({<var>3</var>, <var>5</var>})

11732

<var>stone</var> = st(<var>3</var>, <var>5</var>)

11733

<var>stone</var> = st{<var>3</var>, <var>5</var>} -- by Lua syntax equivalence

11734

<var>stone</var> = st(<var>myfloor</var>)

11735

<var>group</var> = st(no["cherry#*"])

11736

<var>group</var> = st(po(<var>3</var>, <var>5</var>)..po(<var>4</var>, <var>2</var>))

11737

</pre></td></tr></table>

11738

11739

</dd>

11740

</dl>

11741

11742

11743

11744

11745

11746

11747

11748

11749

11750

11751

11752

11753

11754

11755

11756

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

11757

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

11758

11759

</tr></table>

11760

11761

<h3 class="subsection">5.14.11 usertype</h3>

11762

11763

11764

The function ‘<samp>usertype()</samp>’ returns type info for Enigma data types.

11765

11766

11767

<dt> Syntax:</dt>

11768

<dd>usertype(var)

11769

11770

11771

11772

<dd>Any kind of variable.

11773

</dd>

11774

</dl>

11775

11776

</dd>

11777

<dt> Syntax Samples:</dt>

11778

<dd><table><tr><td> </td><td><pre class="example"><var>argtype</var> = usertype(<var>value</var>)

11779

</pre></td></tr></table>

11780

11781

</dd>

11782

<dt> Details:</dt>

11783

<dd>Just for Lua type <code>"userdata"</code> Enigma’s special type info will be returned.

11784

These special types are <code>"object"</code>, <code>"position"</code>, <code>"tile"</code>,

11785

<code>"tiles"</code>, <code>"group"</code>, <code>"world"</code>, <code>"polist"</code> and

11786

<code>"default"</code>. If another data type is encountered, <code>"unknown"</code> will

11787

be returned.

11788

11789

The function <a href="#etype">etype</a> provides a more general type evaluation for arbitrary

11790

data types and is partially based on this function.

11791

11792

</dd>

11793

</dl>

11794

11795

11796

11797

11798

11799

11800

11801

11802

11803

11804

11805

11806

11807

11808

11809

11810

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

11811

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

11812

11813

</tr></table>

11814

11815

<h1 class="chapter">6. Common Attributes and Messages</h1>

11816

11817

Some attributes, messages and constants are common to many objects or even

11818

supported by all objects. We describe them here in detail. The following

11819

chapters will just reference them or even skip them when they are generally

11820

supported and used in the default manner.

11821

11822

11823

<tr><td align="left" valign="top"><a href="#Common-Attributes">6.1 Common Attributes</a></td><td>  </td><td align="left" valign="top">

11824

</td></tr>

11825

<tr><td align="left" valign="top"><a href="#Common-Messages">6.2 Common Messages</a></td><td>  </td><td align="left" valign="top">

11826

</td></tr>

11827

<tr><td align="left" valign="top"><a href="#Common-Constants">6.3 Common Constants</a></td><td>  </td><td align="left" valign="top">

11828

</td></tr>

11829

<tr><td align="left" valign="top"><a href="#Global-Attributes">6.4 Global Attributes</a></td><td>  </td><td align="left" valign="top">

11830

</td></tr>

11831

</table>

11832

11833

11834

11835

11836

11837

11838

11839

11840

11841

11842

11843

11844

11845

11846

11847

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

11848

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

11849

11850

</tr></table>

11851

11852

<h2 class="section">6.1 Common Attributes</h2>

11853

11854

11855

11856

</td></tr>

11857

<tr><td align="left" valign="top"><a href="#state">6.1.2 state</a></td><td>  </td><td align="left" valign="top">

11858

</td></tr>

11859

<tr><td align="left" valign="top"><a href="#target">6.1.3 target</a></td><td>  </td><td align="left" valign="top">

11860

</td></tr>

11861

<tr><td align="left" valign="top"><a href="#action">6.1.4 action</a></td><td>  </td><td align="left" valign="top">

11862

</td></tr>

11863

<tr><td align="left" valign="top"><a href="#nopaction">6.1.5 nopaction</a></td><td>  </td><td align="left" valign="top">

11864

</td></tr>

11865

<tr><td align="left" valign="top"><a href="#safeaction">6.1.6 safeaction</a></td><td>  </td><td align="left" valign="top">

11866

</td></tr>

11867

<tr><td align="left" valign="top"><a href="#inverse">6.1.7 inverse</a></td><td>  </td><td align="left" valign="top">

11868

</td></tr>

11869

<tr><td align="left" valign="top"><a href="#destination">6.1.8 destination</a></td><td>  </td><td align="left" valign="top">

11870

</td></tr>

11871

<tr><td align="left" valign="top"><a href="#friction">6.1.9 friction</a></td><td>  </td><td align="left" valign="top">

11872

</td></tr>

11873

<tr><td align="left" valign="top"><a href="#adhesion">6.1.10 adhesion</a></td><td>  </td><td align="left" valign="top">

11874

</td></tr>

11875

<tr><td align="left" valign="top"><a href="#checkerboard">6.1.11 checkerboard</a></td><td>  </td><td align="left" valign="top">

11876

</td></tr>

11877

<tr><td align="left" valign="top"><a href="#rubbers">6.1.12 rubbers</a></td><td>  </td><td align="left" valign="top">

11878

</td></tr>

11879

<tr><td align="left" valign="top"><a href="#wires">6.1.13 wires</a></td><td>  </td><td align="left" valign="top">

11880

</td></tr>

11881

<tr><td align="left" valign="top"><a href="#fellows">6.1.14 fellows</a></td><td>  </td><td align="left" valign="top">

11882

</td></tr>

11883

</table>

11884

11885

11886

11887

11888

11889

11890

11891

11892

11893

11894

11895

11896

11897

11898

11899

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

11900

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

11901

11902

</tr></table>

11903

11904

11905

11906

The attribute of <a href="#Object-Naming">Object Naming</a> that allows you to name any object for

11907

reference purposes. It is up to you to ensure the uniqueness of the names. But

11908

the engine supports you by autonumbering names ending on a ‘<samp>#</samp>’ sign

11909

(see section <a href="#Object-Naming">Object Naming</a>). If you reuse an already used name the first object will

11910

be unnamed and all name references will point to the new named object. If you

11911

have need of naming an object you should do it with the object creation as

11912

a few objects have need of names and will otherwise be named by the engine with

11913

unique names.

11914

11915

Note that this attribute is not listed in the individual object descriptions.

11916

11917

11918

<dt> Type:   string</dt>

11919

<dt> Values:   {a-zA-Z0-9_}+</dt>

11920

<dd>A sequence of characters of the given characters plus special characters as

11921

mentioned in the text above.

11922

</dd>

11923

<dt> Default:   <code>nil</code></dt>

11924

<dd>Some objects will be autonamed if no name is defined.

11925

</dd>

11926

<dt> Access:   read/write</dt>

11927

<dt> Support:   by all objects</dt>

11928

</dl>

11929

11930

11931

11932

11933

11934

11935

11936

11937

11938

11939

11940

11941

11942

11943

11944

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

11945

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

11946

11947

</tr></table>

11948

11949

<h3 class="subsection">6.1.2 state</h3>

11950

11951

The central attribute of any object that describes the current state of an

11952

object in its standard life cycle. This <a href="#Object-State">Object State</a> is described by

11953

a simple number. Most dynamic objects have just 2 states. Others may have more.

11954

The available states are listed with each object. This universal attribute

11955

allows common messages like <a href="#toggle">toggle</a>, <a href="#signal">signal</a>, <a href="#on">on</a>, <a href="#off">off</a>,

11956

<a href="#open">open</a>, <a href="#close">close</a>.

11957

11958

11959

<dt> Type:   number</dt>

11960

<dt> Values:   dependent on the individual object</dt>

11961

<dd>Please use the given upper case constants.

11962

</dd>

11963

<dt> Default:   <code>0</code></dt>

11964

<dt> Access:   read/sometimes write</dt>

11965

<dd>While it is common to set the state attribute on object creation, it is

11966

preferable to change the object state later on by messages.

11967

</dd>

11968

<dt> Support:   by all objects</dt>

11969

</dl>

11970

11971

11972

11973

11974

11975

11976

11977

11978

11979

11980

11981

11982

11983

11984

11985

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

11986

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

11987

11988

</tr></table>

11989

11990

<h3 class="subsection">6.1.3 target</h3>

11991

11992

All active objects react on being triggered by performing an action on their

11993

targets. This attribute is part of the <a href="#Target-_002d-Action">Target - Action</a> paradigm that

11994

guarantees plugability of objects. You can either set a general ‘<samp>target</samp>’

11995

attribute for an object, or you can set <a href="#state">state</a> dependent attributes

11996

‘<samp>target_0</samp>’, ‘<samp>target_1</samp>’,... (see section <a href="#Object-State">Object State</a>). They all have the

11997

same syntax:

11998

11999

12000

<dt> Type:   string, object, group, tokens   See section <a href="#Object-Description">Object Description</a></dt>

12001

<dd>Single targets may be declared by their object name or their reference. Multiple

12002

targets can be declared by usage of groups and tokens.

12003

</dd>

12004

<dt> Values:   See section <a href="#Object-Attributes">Object Attributes</a></dt>

12005

<dd><table><tr><td> </td><td><pre class="example">target = "myDoor"

12006

target = myObject

12007

target = {"myDoor", myObject}

12008

target = {grp(obj1, obj2), "myDoor", myObject}

12009

</pre></td></tr></table>

12010

12011

</dd>

12012

<dt> Default:   <code>nil</code></dt>

12013

<dt> Access:   read/write</dt>

12014

<dt> Support:   by all objects</dt>

12015

</dl>

12016

12017

12018

12019

12020

12021

12022

12023

12024

12025

12026

12027

12028

12029

12030

12031

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

12032

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

12033

12034

</tr></table>

12035

12036

<h3 class="subsection">6.1.4 action</h3>

12037

12038

All active objects react on being triggered by performing an action on their

12039

targets. This attribute is part of the <a href="#Target-_002d-Action">Target - Action</a> paradigm that

12040

guarantees plugability of objects. You can either set a general ‘<samp>action</samp>’

12041

attribute for an object, or you can set <a href="#state">state</a> dependent attributes

12042

‘<samp>action_0</samp>’, ‘<samp>action_1</samp>’,... (see section <a href="#Object-State">Object State</a>). They all have the

12043

same syntax:

12044

12045

12046

<dt> Type:   string, tokens of strings   See section <a href="#Target-_002d-Action">Target - Action</a></dt>

12047

<dd>A single action may be declared by its message string. Multiple actions that

12048

match multiple targets can be declared by tokens of strings.

12049

</dd>

12050

<dt> Values:   See section <a href="#Object-Attributes">Object Attributes</a></dt>

12051

<dd><table><tr><td> </td><td><pre class="example">action = "open"

12052

action = {"open", "turn", "toggle"}

12053

</pre></td></tr></table>

12054

12055

</dd>

12056

<dt> Default:   <code>nil</code></dt>

12057

<dt> Access:   read/write</dt>

12058

<dt> Support:   by all objects</dt>

12059

</dl>

12060

12061

12062

12063

12064

12065

12066

12067

12068

12069

12070

12071

12072

12073

12074

12075

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

12076

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

12077

12078

</tr></table>

12079

12080

<h3 class="subsection">6.1.5 nopaction</h3>

12081

12082

A very special addition to the <a href="#Target-_002d-Action">Target - Action</a> paradigm that allows

12083

in case of state specific actions to deny the sending of default messages

12084

(see section <a href="#Object-State">Object State</a>).

12085

12086

12087

12088

<dt> Values:   <code>true</code>, <code>false</code></dt>

12089

<dt> Default:   <code>false</code></dt>

12090

<dt> Access:   read/write</dt>

12091

<dt> Support:   by all objects</dt>

12092

</dl>

12093

12094

12095

12096

12097

12098

12099

12100

12101

12102

12103

12104

12105

12106

12107

12108

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

12109

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

12110

12111

</tr></table>

12112

12113

<h3 class="subsection">6.1.6 safeaction</h3>

12114

12115

A very special addition to the <a href="#Target-_002d-Action">Target - Action</a> paradigm that allows

12116

to kill the sender within the execution of the action code.

12117

12118

12119

12120

<dt> Values:   <code>true</code>, <code>false</code></dt>

12121

<dt> Default:   <code>false</code></dt>

12122

<dt> Access:   read/write</dt>

12123

<dt> Support:   by all objects</dt>

12124

</dl>

12125

12126

12127

12128

12129

12130

12131

12132

12133

12134

12135

12136

12137

12138

12139

12140

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

12141

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

12142

12143

</tr></table>

12144

12145

<h3 class="subsection">6.1.7 inverse</h3>

12146

12147

An attribute that requests an inversion of the action value. It is supported by

12148

all objects with boolean action values.

12149

12150

Note that this attribute is not listed in the individual object description

12151

if the object has boolean action values.

12152

12153

12154

12155

<dt> Values:   <code>true</code>, <code>false</code></dt>

12156

<dt> Default:   <code>false</code></dt>

12157

<dt> Access:   read/write</dt>

12158

<dt> Support:   by most objects</dt>

12159

<dd>All objects with boolean action values will support this attribute. Additionally

12160

some objects with other invertible action value types like orientations will

12161

support the inversion of their attributes as stated in the individual object

12162

descriptions.

12163

</dd>

12164

</dl>

12165

12166

12167

12168

12169

12170

12171

12172

12173

12174

12175

12176

12177

12178

12179

12180

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

12181

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

12182

12183

</tr></table>

12184

12185

<h3 class="subsection">6.1.8 destination</h3>

12186

12187

An attribute that describes one or several destinations. It is used by objects

12188

like <a href="#it_005fvortex">it_vortex</a> and <a href="#it_005fwormhole">it_wormhole</a> to describe their teleporting

12189

destination and by <a href="#ac_005fhorse">ac_horse</a> to describe its traveling path.

12190

12191

Note that this attribute is only supported if it is listed in the individual

12192

description.

12193

12194

12195

<dt> Type:   tokens or a single position</dt>

12196

<dd>Just a single position for a first destination is allowed. Use tokens to

12197

define multiple destination.

12198

</dd>

12199

<dt> Values:   See section <a href="#Object-Attributes">Object Attributes</a></dt>

12200

<dd><table><tr><td> </td><td><pre class="example">destination = po(3.0, 4.7)

12201

destination = "myFloor"

12202

destination = myObject

12203

destination = {"vortex2","vortex3","vortex4"}

12204

po["dest1"] = po(3,4)

12205

po["dest2"] = po(7,8)

12206

destination = {"dest1","dest2","myFloor"}

12207

</pre></td></tr></table>

12208

Note that objects like ‘<samp>it_wormhole</samp>’ that have just a single destination

12209

do take the first token object. Note that in contrast to <a href="#target">target</a> tokens a

12210

destination tokens argument can take named positions, too. Referencing floors

12211

that may be destructed by bombs, cracks, floor building stones, etc. are save

12212

destinations, too.

12213

</dd>

12214

<dt> Default:   <code>nil</code></dt>

12215

<dt> Access:   read/write</dt>

12216

<dt> Support:   by teleporting objects</dt>

12217

</dl>

12218

12219

12220

12221

12222

12223

12224

12225

12226

12227

12228

12229

12230

12231

12232

12233

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

12234

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

12235

12236

</tr></table>

12237

12238

<h3 class="subsection">6.1.9 friction</h3>

12239

12240

An attribute that describes the decelerating friction force on actors that are

12241

on the floor. The friction force increases with the speed of the actor and

12242

is decelerating for positive friction values. But friction can be set to

12243

negative values as well what generates an accelerating force that is very

12244

difficult to control for the player.

12245

12246

Besides all floors some floor covering items like <a href="#it_005fstrip">it_strip</a>,

12247

<a href="#it_005fmeditation">it_meditation</a> may provide friction values as well to deviate from the

12248

floor friction.

12249

12250

12251

<dt> Type:   number</dt>

12252

<dt> Values:   any floating point number</dt>

12253

<dt> Default:   <code>nil</code></dt>

12254

<dt> Access:   read/write</dt>

12255

<dt> Support:   by all floor, and floor covering item objects</dt>

12256

</dl>

12257

12258

12259

12260

12261

12262

12263

12264

12265

12266

12267

12268

12269

12270

12271

12272

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

12273

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

12274

12275

</tr></table>

12276

12277

<h3 class="subsection">6.1.10 adhesion</h3>

12278

12279

An attribute that describes the adhesion that allows an actor to accelerate on

12280

a floor. Greater adhesion leads to more accelerating force at the same given

12281

mouse speed. Adhesion can be set to negative values as well what generates an

12282

accelerating force in the inverse direction of the mouse movement which is a

12283

little bit difficult to control for the player.

12284

12285

Besides all floors some floor covering items like <a href="#it_005fstrip">it_strip</a>,

12286

<a href="#it_005fmeditation">it_meditation</a> may provide adhesion values as well to deviate from

12287

the floor adhesion.

12288

12289

12290

<dt> Type:   number</dt>

12291

<dt> Values:   any floating point number</dt>

12292

<dt> Default:   <code>nil</code></dt>

12293

<dt> Access:   read/write</dt>

12294

<dt> Support:   by all floors, and floor covering item objects</dt>

12295

</dl>

12296

12297

12298

12299

12300

12301

12302

12303

12304

12305

12306

12307

12308

12309

12310

12311

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

12312

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

12313

12314

</tr></table>

12315

12316

<h3 class="subsection">6.1.11 checkerboard</h3>

12317

12318

An attribute that defines if a given object declaration should only be applied

12319

on ’even’ or ’uneven’ grid positions. Setting this attribute to ‘<samp>0</samp>’ assures

12320

that this object will only be set on grid positions with an even sum of

12321

<code>x + y</code> grid coordinates, where as a value of ‘<samp>1</samp>’ assures that the

12322

sum must be uneven. This way you can easily provide two different object

12323

declarations for a tile to generate an arbitrarily shaped map of checkerboard

12324

floors, items or stones.

12325

12326

12327

<dt> Type:   number</dt>

12328

<dt> Values:   <code>0</code>, <code>1</code></dt>

12329

<dt> Default:   <code>nil</code></dt>

12330

<dt> Access:   read/write</dt>

12331

<dt> Support:   by all floor, stone and item objects</dt>

12332

<dd><table><tr><td> </td><td><pre class="example">ti["c"] = ti({"fl_sahara", checkerboard=0}) .. {"fl_tigris", checkerboard=1}

12333

</pre></td></tr></table>

12334

</dd>

12335

</dl>

12336

12337

12338

12339

12340

12341

12342

12343

12344

12345

12346

12347

12348

12349

12350

12351

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

12352

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

12353

12354

</tr></table>

12355

12356

<h3 class="subsection">6.1.12 rubbers</h3>

12357

12358

An attribute that gives you access to the <a href="#ot_005frubberband">ot_rubberband</a>s that are

12359

currently connected to this object.

12360

12361

Note that this attribute is read only. You can use the rubberband references

12362

to kill or reconnect single rubberbands. But to add new rubberbands you need

12363

to use the world’s ‘<samp>add</samp>’ method.

12364

12365

12366

<dt> Type:   group of <a href="#ot_005frubberband">ot_rubberband</a> objects</dt>

12367

<dt> Default:   <code>nil</code></dt>

12368

<dt> Access:   read only</dt>

12369

<dt> Support:   by actor and stone objects</dt>

12370

</dl>

12371

12372

12373

12374

12375

12376

12377

12378

12379

12380

12381

12382

12383

12384

12385

12386

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

12387

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

12388

12389

</tr></table>

12390

12391

<h3 class="subsection">6.1.13 wires</h3>

12392

12393

An attribute that gives you access to the <a href="#ot_005fwire">ot_wire</a>s that are

12394

currently connected to this stone object.

12395

12396

Note that this attribute is read only. You can use the wire references

12397

to kill or reconnect single wires. But to add new wires you need

12398

to use the world’s ‘<samp>add</samp>’ method.

12399

12400

12401

<dt> Type:   group of <a href="#ot_005fwire">ot_wire</a> objects</dt>

12402

<dt> Default:   <code>nil</code></dt>

12403

<dt> Access:   read only</dt>

12404

<dt> Support:   by all stone objects</dt>

12405

</dl>

12406

12407

12408

12409

12410

12411

12412

12413

12414

12415

12416

12417

12418

12419

12420

12421

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

12422

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

12423

12424

</tr></table>

12425

12426

<h3 class="subsection">6.1.14 fellows</h3>

12427

12428

An attribute that gives you access to the group of all objects that are currently

12429

connected either by an <a href="#ot_005frubberband">ot_rubberband</a> or an <a href="#ot_005fwire">ot_wire</a>.

12430

12431

Note that this attribute is read only. It is just for evaluation of the current

12432

level state. But to add new rubberbands or wires you need to use the

12433

world’s ‘<samp>add</samp>’ method.

12434

12435

12436

<dt> Type:   group of objects</dt>

12437

<dt> Default:   <code>nil</code></dt>

12438

<dt> Access:   read only</dt>

12439

<dt> Support:   by actor and stone objects</dt>

12440

</dl>

12441

12442

12443

12444

12445

12446

12447

12448

12449

12450

12451

12452

12453

12454

12455

12456

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

12457

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

12458

12459

</tr></table>

12460

12461

<h2 class="section">6.2 Common Messages</h2>

12462

12463

12464

<tr><td align="left" valign="top"><a href="#toggle">6.2.1 toggle</a></td><td>  </td><td align="left" valign="top">

12465

</td></tr>

12466

12467

</td></tr>

12468

<tr><td align="left" valign="top"><a href="#signal">6.2.3 signal</a></td><td>  </td><td align="left" valign="top">

12469

</td></tr>

12470

12471

</td></tr>

12472

12473

</td></tr>

12474

12475

</td></tr>

12476

<tr><td align="left" valign="top"><a href="#close">6.2.7 close</a></td><td>  </td><td align="left" valign="top">

12477

</td></tr>

12478

<tr><td align="left" valign="top"><a href="#ignite">6.2.8 ignite</a></td><td>  </td><td align="left" valign="top">

12479

</td></tr>

12480

12481

</td></tr>

12482

<tr><td align="left" valign="top"><a href="#setfire">6.2.10 setfire</a></td><td>  </td><td align="left" valign="top">

12483

</td></tr>

12484

12485

</td></tr>

12486

<tr><td align="left" valign="top"><a href="#sound">6.2.12 sound</a></td><td>  </td><td align="left" valign="top">

12487

</td></tr>

12488

<tr><td align="left" valign="top"><a href="#disconnect">6.2.13 disconnect</a></td><td>  </td><td align="left" valign="top">

12489

</td></tr>

12490

</table>

12491

12492

12493

12494

12495

12496

12497

12498

12499

12500

12501

12502

12503

12504

12505

12506

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

12507

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

12508

12509

</tr></table>

12510

12511

<h3 class="subsection">6.2.1 toggle</h3>

12512

12513

This is the default message that is always taken if no other message is provided.

12514

It toggles the <a href="#Object-State">Object State</a> quite independent of the very nature of the

12515

state. Two-stated objects like switches will toggle their state form ‘<samp>ON</samp>’

12516

to ‘<samp>OFF</samp>’ or from ‘<samp>OFF</samp>’ to ‘<samp>ON</samp>’. Door like objects will toggle

12517

their state from ‘<samp>OPEN</samp>’ to ‘<samp>CLOSED</samp>’ or from ‘<samp>CLOSED</samp>’ to

12518

‘<samp>OPEN</samp>’. Other objects like <a href="#st_005ffourswitch">st_fourswitch</a> will turn into the next

12519

orientation. Generally the object will toggle to its next state.

12520

12521

12522

<dt> Value:   -</dt>

12523

<dt> Returns:   -</dt>

12524

<dt> Support:   by nearly all objects which use the ‘<samp>state</samp>’ attribute</dt>

12525

</dl>

12526

12527

12528

12529

12530

12531

12532

12533

12534

12535

12536

12537

12538

12539

12540

12541

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

12542

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

12543

12544

</tr></table>

12545

12546

12547

12548

A dummy message that just does nothing: no operation. You may need it in cases

12549

of state dependent actions to block an otherwise sent default ‘<samp>toggle</samp>’

12550

message (see section <a href="#Object-State">Object State</a>).

12551

12552

12553

<dt> Value:   -</dt>

12554

<dt> Returns:   -</dt>

12555

<dt> Support:   by all objects</dt>

12556

</dl>

12557

12558

12559

12560

12561

12562

12563

12564

12565

12566

12567

12568

12569

12570

12571

12572

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

12573

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

12574

12575

</tr></table>

12576

12577

<h3 class="subsection">6.2.3 signal</h3>

12578

12579

A signal message tries to set the object to the state 0 (‘<samp>OFF</samp>’,

12580

‘<samp>CLOSED</samp>’) or state 1 (‘<samp>ON</samp>’, ‘<samp>OPEN</samp>’) according to its value. This

12581

message allows you to keep the states of an action source and a receiving object

12582

in sync. Note that values like ‘<samp>true</samp>’, ‘<samp>false</samp>’ and orientation values

12583

like ‘<samp>WEST</samp>’ to ‘<samp>NORTH</samp>’ are converted to 0 and 1. This allows you to

12584

use ‘<samp>signal</samp>’ as action message on most objects.

12585

12586

12587

<dt> Value:   <code>0</code>, <code>1</code></dt>

12588

<dt> Returns:   -</dt>

12589

<dt> Support:   by nearly all objects which use the ‘<samp>state</samp>’ attribute</dt>

12590

</dl>

12591

12592

12593

12594

12595

12596

12597

12598

12599

12600

12601

12602

12603

12604

12605

12606

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

12607

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

12608

12609

</tr></table>

12610

12611

12612

12613

This message is just supported by objects that can be switched on and off. Just

12614

objects in state ‘<samp>OFF</samp>’ will be switched on. An object in state ‘<samp>ON</samp>’

12615

remains unchanged in its state.

12616

12617

12618

<dt> Value:   -</dt>

12619

<dt> Returns:   -</dt>

12620

<dt> Support:   by objects that can be switched on and off</dt>

12621

</dl>

12622

12623

12624

12625

12626

12627

12628

12629

12630

12631

12632

12633

12634

12635

12636

12637

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

12638

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

12639

12640

</tr></table>

12641

12642

12643

12644

This message is just supported by objects that can be switched on and off. Just

12645

objects in state ‘<samp>ON</samp>’ will be switched off. An object in state ‘<samp>OFF</samp>’

12646

remains unchanged in its state.

12647

12648

12649

<dt> Value:   -</dt>

12650

<dt> Returns:   -</dt>

12651

<dt> Support:   by objects that can be switched on and off</dt>

12652

</dl>

12653

12654

12655

12656

12657

12658

12659

12660

12661

12662

12663

12664

12665

12666

12667

12668

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

12669

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

12670

12671

</tr></table>

12672

12673

12674

12675

This message is just supported by door like objects that can be opened and closed.

12676

Just objects in state ‘<samp>CLOSED</samp>’ will be opened. An object in state

12677

‘<samp>OPEN</samp>’ remains unchanged in its state.

12678

12679

12680

<dt> Value:   -</dt>

12681

<dt> Returns:   -</dt>

12682

<dt> Support:   by door like objects that can be opened and closed</dt>

12683

</dl>

12684

12685

12686

12687

12688

12689

12690

12691

12692

12693

12694

12695

12696

12697

12698

12699

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

12700

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

12701

12702

</tr></table>

12703

12704

<h3 class="subsection">6.2.7 close</h3>

12705

12706

This message is just supported by door like objects that can be opened and closed.

12707

Just objects in state ‘<samp>OPEN</samp>’ will be closed. An object in state

12708

‘<samp>CLOSED</samp>’ remains unchanged in its state.

12709

12710

12711

<dt> Value:   -</dt>

12712

<dt> Returns:   -</dt>

12713

<dt> Support:   by door like objects that can be opened and closed</dt>

12714

</dl>

12715

12716

12717

12718

12719

12720

12721

12722

12723

12724

12725

12726

12727

12728

12729

12730

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

12731

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

12732

12733

</tr></table>

12734

12735

<h3 class="subsection">6.2.8 ignite</h3>

12736

12737

Sets fire to a floor if it is burnable (see section <a href="#Fire-Spreading">Fire Spreading</a>) or start an

12738

explosion or shattering of items like <a href="#it_005fdynamite">it_dynamite</a>, <a href="#it_005fbomb">it_bomb</a> or

12739

stones like <a href="#st_005fice">st_ice</a>, <a href="#st_005fdispenser">st_dispenser</a> and many more.

12740

12741

12742

<dt> Value:   -</dt>

12743

<dt> Returns:   -</dt>

12744

<dt> Support:   by all <a href="#Floor-Objects">Floor Objects</a> and explosive or shattering items and stones</dt>

12745

</dl>

12746

12747

12748

12749

12750

12751

12752

12753

12754

12755

12756

12757

12758

12759

12760

12761

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

12762

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

12763

12764

</tr></table>

12765

12766

12767

12768

Sets fire to a floor if it is burnable (see section <a href="#Fire-Spreading">Fire Spreading</a>) or causes a

12769

<a href="#Heat_002dTransformation">Heat-Transformation</a> on a floor or other objects like <a href="#st_005fice">st_ice</a> that

12770

starts melting. Some objects do react on a heat message like on an <a href="#ignite">ignite</a>

12771

message by explosions or shattering.

12772

12773

12774

<dt> Value:   -</dt>

12775

<dt> Returns:   -</dt>

12776

<dt> Support:   by all <a href="#Floor-Objects">Floor Objects</a> and some other objects.</dt>

12777

</dl>

12778

12779

12780

12781

12782

12783

12784

12785

12786

12787

12788

12789

12790

12791

12792

12793

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

12794

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

12795

12796

</tr></table>

12797

12798

<h3 class="subsection">6.2.10 setfire</h3>

12799

12800

Sets fire to a floor if it is burnable (see section <a href="#Fire-Spreading">Fire Spreading</a>).

12801

12802

12803

<dt> Value:   -</dt>

12804

<dt> Returns:   -</dt>

12805

<dt> Support:   by all <a href="#Floor-Objects">Floor Objects</a></dt>

12806

</dl>

12807

12808

12809

12810

12811

12812

12813

12814

12815

12816

12817

12818

12819

12820

12821

12822

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

12823

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

12824

12825

</tr></table>

12826

12827

12828

12829

This message causes the recipient to cease to exist. You are just allowed to

12830

kill objects that are directly part of the world. Objects owned by players,

12831

being content part of a bag or otherwise owned by another object will refuse

12832

this message on behalf of their owner.

12833

12834

12835

<dt> Value:   -</dt>

12836

<dt> Returns:   -</dt>

12837

<dt> Support:   by all world owned objects</dt>

12838

</dl>

12839

12840

12841

12842

12843

12844

12845

12846

12847

12848

12849

12850

12851

12852

12853

12854

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

12855

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

12856

12857

</tr></table>

12858

12859

<h3 class="subsection">6.2.12 sound</h3>

12860

12861

This message causes the recipient to play the sound given by the first

12862

string argument value. It is played at the position of the object. The

12863

volume can be defined by a second number argument and defaults to <code>1.0</code>.

12864

12865

12866

<dt> Value:   string [, number]</dt>

12867

<dt> Returns:   -</dt>

12868

<dt> Support:   by all objects</dt>

12869

</dl>

12870

12871

12872

12873

12874

12875

12876

12877

12878

12879

12880

12881

12882

12883

12884

12885

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

12886

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

12887

12888

</tr></table>

12889

12890

<h3 class="subsection">6.2.13 disconnect</h3>

12891

12892

This message causes the recipient to disconnect from all <a href="#fellows">fellows</a> by

12893

cutting all <a href="#wires">wires</a> and <a href="#rubbers">rubbers</a> that are connected to it.

12894

12895

12896

<dt> Value:   -</dt>

12897

<dt> Returns:   -</dt>

12898

<dt> Support:   by all objects</dt>

12899

</dl>

12900

12901

12902

12903

12904

12905

12906

12907

12908

12909

12910

12911

12912

12913

12914

12915

12916

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

12917

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

12918

12919

</tr></table>

12920

12921

<h2 class="section">6.3 Common Constants</h2>

12922

12923

Constants for <a href="#Pseudo-Datatypes">Pseudo Datatypes</a>.

12924

12925

12926

<tr><td align="left" valign="top"><a href="#state-values">6.3.1 state values</a></td><td>  </td><td align="left" valign="top">

12927

</td></tr>

12928

<tr><td align="left" valign="top"><a href="#color-values">6.3.2 color values</a></td><td>  </td><td align="left" valign="top">

12929

</td></tr>

12930

<tr><td align="left" valign="top"><a href="#actor-controllers">6.3.3 actor controllers</a></td><td>  </td><td align="left" valign="top">

12931

</td></tr>

12932

<tr><td align="left" valign="top"><a href="#oxyd-colors">6.3.4 oxyd colors</a></td><td>  </td><td align="left" valign="top">

12933

</td></tr>

12934

<tr><td align="left" valign="top"><a href="#orientations">6.3.5 orientations</a></td><td>  </td><td align="left" valign="top">

12935

</td></tr>

12936

<tr><td align="left" valign="top"><a href="#direction-offsets">6.3.6 direction offsets</a></td><td>  </td><td align="left" valign="top">

12937

</td></tr>

12938

<tr><td align="left" valign="top"><a href="#position-lists">6.3.7 position lists</a></td><td>  </td><td align="left" valign="top">

12939

</td></tr>

12940

<tr><td align="left" valign="top"><a href="#essentialness">6.3.8 essentialness</a></td><td>  </td><td align="left" valign="top">

12941

</td></tr>

12942

<tr><td align="left" valign="top"><a href="#meditation-types">6.3.9 meditation types</a></td><td>  </td><td align="left" valign="top">

12943

</td></tr>

12944

<tr><td align="left" valign="top"><a href="#glasses-abilities">6.3.10 glasses abilities</a></td><td>  </td><td align="left" valign="top">

12945

</td></tr>

12946

<tr><td align="left" valign="top"><a href="#coinslot-acceptance">6.3.11 coinslot acceptance</a></td><td>  </td><td align="left" valign="top">

12947

</td></tr>

12948

<tr><td align="left" valign="top"><a href="#rubberband-length">6.3.12 rubberband length</a></td><td>  </td><td align="left" valign="top">

12949

</td></tr>

12950

<tr><td align="left" valign="top"><a href="#subsoil-kind">6.3.13 subsoil kind</a></td><td>  </td><td align="left" valign="top">

12951

</td></tr>

12952

<tr><td align="left" valign="top"><a href="#screen-scrolling">6.3.14 screen scrolling</a></td><td>  </td><td align="left" valign="top">

12953

</td></tr>

12954

<tr><td align="left" valign="top"><a href="#map-read-directions">6.3.15 map read directions</a></td><td>  </td><td align="left" valign="top">

12955

</td></tr>

12956

</table>

12957

12958

12959

12960

12961

12962

12963

12964

12965

12966

12967

12968

12969

12970

12971

12972

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

12973

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

12974

12975

</tr></table>

12976

12977

<h3 class="subsection">6.3.1 state values</h3>

12978

12979

Number constants for object attribute <a href="#state">state</a>. Please choose the constant

12980

that is appropriate for an object and do avoid using numbers.

12981

12982

<ul>

12983

<li> ‘<samp>OFF</samp>’ = <code>0</code>, all switch like objects

12984

</li><li> ‘<samp>ON</samp>’ = <code>1</code>, all switch like objects

12985

</li><li> ‘<samp>CLOSED</samp>’ = <code>0</code>, all door like objects

12986

</li><li> ‘<samp>OPEN</samp>’ = <code>1</code>, all door like objects

12987

</li><li> ‘<samp>IDLE</samp>’ = <code>0</code>, other objects in the default passive state

12988

</li><li> ‘<samp>ACTIVE</samp>’ = <code>1</code>, other objects in the active state

12989

</li><li> ‘<samp>INACTIVE</samp>’ = <code>2</code>, other objects in the inactive state

12990

</li><li> ‘<samp>OXYDPAIR</samp>’ = <code>2</code>, just by <a href="#st_005foxyd">st_oxyd</a>

12991

</li><li> ‘<samp>LIGHT</samp>’ = <code>0</code>, by <a href="#st_005fdisco">st_disco</a>

12992

</li><li> ‘<samp>MEDIUM</samp>’ = <code>1</code>, by <a href="#st_005fdisco">st_disco</a>, <a href="#it_005fcrack">it_crack</a>, <a href="#it_005fextinguisher">it_extinguisher</a>

12993

</li><li> ‘<samp>DARK</samp>’ = <code>2</code>, by <a href="#st_005fdisco">st_disco</a>

12994

</li><li> ‘<samp>FLOODING</samp>’ = <code>1</code>, by <a href="#fl_005fwater">fl_water</a>, <a href="#fl_005fwood">fl_wood</a>, <a href="#fl_005fhay">fl_hay</a>, <a href="#fl_005frock">fl_rock</a>

12995

</li><li> ‘<samp>INVISIBLE</samp>’ = <code>-1</code>, by <a href="#it_005fcrack">it_crack</a>

12996

</li><li> ‘<samp>SMALL</samp>’ = <code>0</code>, by <a href="#it_005fcrack">it_crack</a>

12997

</li><li> ‘<samp>LARGE</samp>’ = <code>2</code>, by <a href="#it_005fcrack">it_crack</a>

12998

</li><li> ‘<samp>YIN</samp>’ = <code>0</code>, by <a href="#fl_005fyinyang">fl_yinyang</a> and all actors as <a href="#owner">owner</a> value

12999

</li><li> ‘<samp>YANG</samp>’ = <code>1</code>, by <a href="#fl_005fyinyang">fl_yinyang</a> and all actors as <a href="#owner">owner</a> value

13000

</li><li> ‘<samp>EMPTY</samp>’ = <code>0</code>, by <a href="#it_005fextinguisher">it_extinguisher</a>

13001

</li><li> ‘<samp>FULL</samp>’ = <code>2</code>, by <a href="#it_005fextinguisher">it_extinguisher</a>

13002

</li><li> ‘<samp>BROKEN</samp>’ = <code>1</code>, by <a href="#it_005fbottle">it_bottle</a>

13003

</li><li> ‘<samp>BREAKING</samp>’ = <code>2</code>, by <a href="#st_005fquake">st_quake</a>

13004

</li><li> ‘<samp>CW</samp>’ = <code>0</code>, clockwise, by <a href="#st_005frotator">st_rotator</a>

13005

</li><li> ‘<samp>CCW</samp>’ = <code>1</code>, counterclockwise, by <a href="#st_005frotator">st_rotator</a>

13006

</li></ul>

13007

13008

13009

13010

13011

13012

13013

13014

13015

13016

13017

13018

13019

13020

13021

13022

13023

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

13024

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

13025

13026

</tr></table>

13027

13028

<h3 class="subsection">6.3.2 color values</h3>

13029

13030

Number constants for attribute <a href="#color">color</a>. Please choose the constant

13031

that is appropriate for an object and do avoid using numbers. Note that objects

13032

do support a color attribute only, if it is related to a functionality. The

13033

color of <a href="#st_005foxyd">st_oxyd</a> uses another enumeration scheme due to legacy reasons,

13034

see section <a href="#oxyd-colors">oxyd colors</a>.

13035

13036

<ul>

13037

<li> ‘<samp>BLACK</samp>’ = <code>0</code>, all black/white colored objects

13038

</li><li> ‘<samp>WHITE</samp>’ = <code>1</code>, all black/white colored objects

13039

</li><li> ‘<samp>BLUE</samp>’ = <code>2</code>, by <a href="#st_005fpuzzle">st_puzzle</a>

13040

</li><li> ‘<samp>YELLOW</samp>’ = <code>3</code>, by <a href="#st_005fpuzzle">st_puzzle</a>

13041

</li><li> ‘<samp>NOCOLOR</samp>’ = <code>nil</code>, some objects, that exist in black, white variants,

13042

too, like <a href="#st_005fswitch">st_switch</a>

13043

</li></ul>

13044

13045

13046

13047

13048

13049

13050

13051

13052

13053

13054

13055

13056

13057

13058

13059

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

13060

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

13061

13062

</tr></table>

13063

13064

<h3 class="subsection">6.3.3 actor controllers</h3>

13065

13066

Number constants for actor attribute <a href="#controllers">controllers</a>. Please choose the

13067

constant that is appropriate for an object and do avoid using numbers.

13068

13069

<ul>

13070

<li> ‘<samp>CTRL_NONE</samp>’ = <code>0</code>, by all actors

13071

</li><li> ‘<samp>CTRL_YIN</samp>’ = <code>1</code>, by all actors

13072

</li><li> ‘<samp>CTRL_YANG</samp>’ = <code>2</code>, by all actors

13073

</li><li> ‘<samp>CTRL_YINYANG</samp>’ = <code>3</code>, by all actors

13074

</li></ul>

13075

13076

13077

13078

13079

13080

13081

13082

13083

13084

13085

13086

13087

13088

13089

13090

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

13091

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

13092

13093

</tr></table>

13094

13095

<h3 class="subsection">6.3.4 oxyd colors</h3>

13096

13097

Number constants for <a href="#st_005foxyd">st_oxyd</a> attribute ‘<samp>oxydcolor</samp>’. Please choose the

13098

constant that is appropriate for an object and do avoid using numbers.

13099

13100

<ul>

13101

13102

</li><li> ‘<samp>OXYD_RED</samp>’ = <code>1</code>, by <a href="#st_005foxyd">st_oxyd</a>

13103

</li><li> ‘<samp>OXYD_GREEN</samp>’ = <code>2</code>, by <a href="#st_005foxyd">st_oxyd</a>

13104

</li><li> ‘<samp>OXYD_YELLOW</samp>’ = <code>3</code>, by <a href="#st_005foxyd">st_oxyd</a>

13105

</li><li> ‘<samp>OXYD_CYAN</samp>’ = <code>4</code>, by <a href="#st_005foxyd">st_oxyd</a>

13106

</li><li> ‘<samp>OXYD_PURPLE</samp>’ = <code>5</code>, by <a href="#st_005foxyd">st_oxyd</a>

13107

</li><li> ‘<samp>OXYD_WHITE</samp>’ = <code>6</code>, by <a href="#st_005foxyd">st_oxyd</a>

13108

</li><li> ‘<samp>OXYD_BLACK</samp>’ = <code>7</code>, by <a href="#st_005foxyd">st_oxyd</a>

13109

</li><li> ‘<samp>OXYD_GRAY</samp>’ = <code>8</code>, by <a href="#st_005foxyd">st_oxyd</a>

13110

</li><li> ‘<samp>OXYD_ORANGE</samp>’ = <code>9</code>, by <a href="#st_005foxyd">st_oxyd</a>

13111

</li><li> ‘<samp>OXYD_PINE</samp>’ = <code>10</code>, by <a href="#st_005foxyd">st_oxyd</a>

13112

</li><li> ‘<samp>OXYD_BROWN</samp>’ = <code>11</code>, by <a href="#st_005foxyd">st_oxyd</a>

13113

</li><li> ‘<samp>OXYD_AUTO</samp>’ = <code>-1</code>, by <a href="#st_005foxyd">st_oxyd</a>

13114

</li><li> ‘<samp>OXYD_FAKE</samp>’ = <code>-2</code>, by <a href="#st_005foxyd">st_oxyd</a>

13115

</li><li> ‘<samp>OXYD_QUAKE</samp>’ = <code>-3</code>, by <a href="#st_005foxyd">st_oxyd</a>

13116

</li><li> ‘<samp>OXYD_BOLD</samp>’ = <code>-4</code>, by <a href="#st_005foxyd">st_oxyd</a>

13117

</li></ul>

13118

13119

13120

13121

13122

13123

13124

13125

13126

13127

13128

13129

13130

13131

13132

13133

13134

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

13135

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

13136

13137

</tr></table>

13138

13139

<h3 class="subsection">6.3.5 orientations</h3>

13140

13141

Number constants for attributes ‘<samp>orientation</samp>’ or ‘<samp>slope</samp>’. Please

13142

choose the constant that is appropriate for an object and do avoid using numbers.

13143

13144

<ul>

13145

<li> ‘<samp>RANDOMDIR</samp>’ = <code>-2</code>, by <a href="#st_005fmirror">st_mirror</a>

13146

</li><li> ‘<samp>NODIR</samp>’ = <code>-1</code>, by <a href="#fl_005fslope">fl_slope</a>

13147

</li><li> ‘<samp>WEST</samp>’ = <code>0</code>, by all objects with 4 orientations

13148

</li><li> ‘<samp>SOUTH</samp>’ = <code>1</code>, by all objects with 4 orientations

13149

</li><li> ‘<samp>EAST</samp>’ = <code>2</code>, by all objects with 4 orientations

13150

</li><li> ‘<samp>NORTH</samp>’ = <code>3</code>, by all objects with 4 orientations

13151

</li><li> ‘<samp>NORTHWEST</samp>’ = <code>4</code>, by all objects with 8 orientations

13152

</li><li> ‘<samp>SOUTHWEST</samp>’ = <code>5</code>, by all objects with 8 orientations

13153

</li><li> ‘<samp>SOUTHEAST</samp>’ = <code>6</code>, by all objects with 8 orientations

13154

</li><li> ‘<samp>NORTHEAST</samp>’ = <code>7</code>, by all objects with 8 orientations

13155

</li></ul>

13156

13157

Just for <a href="#st_005fmirror">st_mirror</a> another alternative orientation notation exists:

13158

13159

<ul>

13160

<li> ‘<samp>BACKSLASH</samp>’ = <code>0</code>, by <a href="#st_005fmirror">st_mirror</a>

13161

</li><li> ‘<samp>HORIZONTAL</samp>’ = <code>1</code>, by <a href="#st_005fmirror">st_mirror</a>

13162

</li><li> ‘<samp>SLASH</samp>’ = <code>2</code>, by <a href="#st_005fmirror">st_mirror</a>

13163

</li><li> ‘<samp>VERTICAL</samp>’ = <code>3</code>, by <a href="#st_005fmirror">st_mirror</a>

13164

</li></ul>

13165

13166

13167

13168

13169

13170

13171

13172

13173

13174

13175

13176

13177

13178

13179

13180

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

13181

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

13182

13183

</tr></table>

13184

13185

<h3 class="subsection">6.3.6 direction offsets</h3>

13186

13187

Position constants as vectorial direction offsets. Please choose the constant

13188

that is appropriate for a calculation and do avoid using the trivial positions

13189

instead.

13190

13191

<ul>

13192

13193

</li><li> ‘<samp>E</samp>’ = <code>po(1, 0)</code>

13194

</li><li> ‘<samp>S</samp>’ = <code>po(0, 1)</code>

13195

</li><li> ‘<samp>W</samp>’ = <code>po(-1, 0)</code>

13196

</li><li> ‘<samp>NE</samp>’ = <code>N + E</code>

13197

</li><li> ‘<samp>NW</samp>’ = <code>N + W</code>

13198

</li><li> ‘<samp>SE</samp>’ = <code>S + E</code>

13199

</li><li> ‘<samp>SW</samp>’ = <code>S + W</code>

13200

</li><li> ‘<samp>NNE</samp>’ = <code>N + NE</code>, by <a href="#st_005fchess">st_chess</a>

13201

</li><li> ‘<samp>ENE</samp>’ = <code>E + NE</code>, by <a href="#st_005fchess">st_chess</a>

13202

</li><li> ‘<samp>ESE</samp>’ = <code>E + SE</code>, by <a href="#st_005fchess">st_chess</a>

13203

</li><li> ‘<samp>SSE</samp>’ = <code>S + SE</code>, by <a href="#st_005fchess">st_chess</a>

13204

</li><li> ‘<samp>SSW</samp>’ = <code>S + SW</code>, by <a href="#st_005fchess">st_chess</a>

13205

</li><li> ‘<samp>WSW</samp>’ = <code>W + SW</code>, by <a href="#st_005fchess">st_chess</a>

13206

</li><li> ‘<samp>WNW</samp>’ = <code>W + NW</code>, by <a href="#st_005fchess">st_chess</a>

13207

</li><li> ‘<samp>NNW</samp>’ = <code>N + NW</code>, by <a href="#st_005fchess">st_chess</a>

13208

</li></ul>

13209

13210

13211

13212

13213

13214

13215

13216

13217

13218

13219

13220

13221

13222

13223

13224

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

13225

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

13226

13227

</tr></table>

13228

13229

<h3 class="subsection">6.3.7 position lists</h3>

13230

13231

Position list constants. Please choose the constant that is appropriate for a

13232

calculation and do avoid using the trivial position lists instead.

13233

13234

<ul>

13235

<li> ‘<samp>NEIGHBORS_4</samp>’ = <code>W .. S .. E .. N</code>

13236

</li><li> ‘<samp>NEIGHBORS_8</samp>’ = <code>NEIGHBORS_4 .. NW .. SW ..SE .. NE</code>

13237

</li><li> ‘<samp>NEIGHBORS_CHESS</samp>’ = <code>NNE .. ENE .. ESE .. SSE .. SSW .. WSW .. WNW .. NNW</code>

13238

</li></ul>

13239

13240

13241

13242

13243

13244

13245

13246

13247

13248

13249

13250

13251

13252

13253

13254

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

13255

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

13256

13257

</tr></table>

13258

13259

<h3 class="subsection">6.3.8 essentialness</h3>

13260

13261

Number constants for attribute <a href="#essential">essential</a>. Please choose the constant that

13262

is appropriate for an object and do avoid using numbers.

13263

13264

<ul>

13265

<li> ‘<samp>DISPENSABLE</samp>’ = <code>0</code>, by all actors and <a href="#it_005fmeditation">it_meditation</a>

13266

</li><li> ‘<samp>INDISPENSABLE</samp>’ = <code>1</code>, by all actors and <a href="#it_005fmeditation">it_meditation</a>

13267

</li><li> ‘<samp>PERKIND</samp>’ = <code>2</code>, by all actors

13268

</li></ul>

13269

13270

13271

13272

13273

13274

13275

13276

13277

13278

13279

13280

13281

13282

13283

13284

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

13285

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

13286

13287

</tr></table>

13288

13289

<h3 class="subsection">6.3.9 meditation types</h3>

13290

13291

Number constants for <a href="#it_005fmeditation">it_meditation</a> attribute <a href="#state">state</a>. Please choose

13292

the constant that is appropriate for an object and do avoid using numbers.

13293

13294

<ul>

13295

<li> ‘<samp>MEDITATION_CALDERA</samp>’ = <code>-3</code>, by <a href="#it_005fmeditation">it_meditation</a>

13296

</li><li> ‘<samp>MEDITATION_HOLLOW</samp>’ = <code>-2</code>, by <a href="#it_005fmeditation">it_meditation</a>

13297

</li><li> ‘<samp>MEDITATION_DENT</samp>’ = <code>-1</code>, by <a href="#it_005fmeditation">it_meditation</a>

13298

</li><li> ‘<samp>MEDITATION_BUMP</samp>’ = <code>1</code>, by <a href="#it_005fmeditation">it_meditation</a>

13299

</li><li> ‘<samp>MEDITATION_HILL</samp>’ = <code>2</code>, by <a href="#it_005fmeditation">it_meditation</a>

13300

</li><li> ‘<samp>MEDITATION_VOLCANO</samp>’ = <code>3</code>, by <a href="#it_005fmeditation">it_meditation</a>

13301

</li></ul>

13302

13303

13304

13305

13306

13307

13308

13309

13310

13311

13312

13313

13314

13315

13316

13317

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

13318

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

13319

13320

</tr></table>

13321

13322

<h3 class="subsection">6.3.10 glasses abilities</h3>

13323

13324

Number constants for <a href="#it_005fglasses">it_glasses</a> attribute <a href="#state">state</a> and global variable

13325

<a href="#ExtralifeGlasses">ExtralifeGlasses</a>. Please use sums of the constants that are appropriate

13326

for your glasses and do avoid using numbers.

13327

13328

<ul>

13329

<li> ‘<samp>SPOT_NOTHING</samp>’ = <code>0</code>, by <a href="#it_005fglasses">it_glasses</a>

13330

</li><li> ‘<samp>SPOT_DEATH</samp>’ = <code>1</code>, by <a href="#it_005fglasses">it_glasses</a>

13331

</li><li> ‘<samp>SPOT_HOLLOW</samp>’ = <code>2</code>, by <a href="#it_005fglasses">it_glasses</a>

13332

</li><li> ‘<samp>SPOT_ACTORIMPULSE</samp>’ = <code>4</code>, by <a href="#it_005fglasses">it_glasses</a>

13333

</li><li> ‘<samp>SPOT_SENSOR</samp>’ = <code>8</code>, by <a href="#it_005fglasses">it_glasses</a>

13334

</li><li> ‘<samp>SPOT_LIGHTPASSENGER</samp>’ = <code>16</code>, by <a href="#it_005fglasses">it_glasses</a>

13335

</li><li> ‘<samp>SPOT_TRAP</samp>’ = <code>32</code>, by <a href="#it_005fglasses">it_glasses</a>

13336

</li></ul>

13337

13338

13339

13340

13341

13342

13343

13344

13345

13346

13347

13348

13349

13350

13351

13352

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

13353

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

13354

13355

</tr></table>

13356

13357

<h3 class="subsection">6.3.11 coinslot acceptance</h3>

13358

13359

Number constants for <a href="#st_005fcoinslot">st_coinslot</a> attributes ‘<samp>interval_*</samp>’. Please

13360

choose the constant that is appropriate for the coinslot and do avoid using

13361

numbers.

13362

13363

<ul>

13364

<li> ‘<samp>COIN_IGNORE</samp>’ = <code>-1</code>, by <a href="#st_005fcoinslot">st_coinslot</a>

13365

</li><li> ‘<samp>COIN_REJECT</samp>’ = <code>-2</code>, by <a href="#st_005fcoinslot">st_coinslot</a>

13366

</li></ul>

13367

13368

13369

13370

13371

13372

13373

13374

13375

13376

13377

13378

13379

13380

13381

13382

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

13383

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

13384

13385

</tr></table>

13386

13387

<h3 class="subsection">6.3.12 rubberband length</h3>

13388

13389

Number constant for <a href="#it_005frubberband">it_rubberband</a>, <a href="#st_005frubberband">st_rubberband</a> and <a href="#ot_005frubberband">ot_rubberband</a>

13390

attribute ‘<samp>length</samp>’. Please choose the constant that is appropriate for the

13391

rubberband length and do avoid using numbers.

13392

13393

<ul>

13394

<li> ‘<samp>AUTOLENGTH</samp>’ = <code>-1</code>, by <a href="#it_005frubberband">it_rubberband</a>, <a href="#st_005frubberband">st_rubberband</a> and <a href="#ot_005frubberband">ot_rubberband</a>

13395

</li></ul>

13396

13397

13398

13399

13400

13401

13402

13403

13404

13405

13406

13407

13408

13409

13410

13411

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

13412

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

13413

13414

</tr></table>

13415

13416

<h3 class="subsection">6.3.13 subsoil kind</h3>

13417

13418

Number constants for the global attribute <a href="#SubSoil">SubSoil</a>. Please

13419

choose the constant that is appropriate for the SubSoil and do avoid using

13420

numbers.

13421

13422

<ul>

13423

<li> ‘<samp>SUBSOIL_ABYSS</samp>’ = <code>0</code>, by <a href="#it_005fexplosion">it_explosion</a>

13424

</li><li> ‘<samp>SUBSOIL_WATER</samp>’ = <code>1</code>, by <a href="#it_005fexplosion">it_explosion</a>

13425

</li><li> ‘<samp>SUBSOIL_AUTO</samp>’ = <code>2</code>, by <a href="#it_005fexplosion">it_explosion</a>

13426

</li></ul>

13427

13428

13429

13430

13431

13432

13433

13434

13435

13436

13437

13438

13439

13440

13441

13442

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

13443

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

13444

13445

</tr></table>

13446

13447

<h3 class="subsection">6.3.14 screen scrolling</h3>

13448

13449

Constants for screen scrolling global attributes <a href="#FollowMethod">FollowMethod</a> and

13450

<a href="#FollowAction">FollowAction</a>. Please choose the constants that are appropriate for

13451

screen scrolling and do avoid using numbers or position values.

13452

13453

<ul>

13454

<li> ‘<samp>FOLLOW_NO</samp>’ = <code>0</code>, by global <a href="#FollowMethod">FollowMethod</a>

13455

</li><li> ‘<samp>FOLLOW_SCROLL</samp>’ = <code>1</code>, by global <a href="#FollowMethod">FollowMethod</a>

13456

</li><li> ‘<samp>FOLLOW_FLIP</samp>’ = <code>2</code>, by global <a href="#FollowMethod">FollowMethod</a>

13457

</li></ul>

13458

13459

<ul>

13460

<li> ‘<samp>FOLLOW_FULLSCREEN</samp>’ = <code>po(19, 12)</code>, by global <a href="#FollowAction">FollowAction</a>

13461

</li><li> ‘<samp>FOLLOW_HALFSCREEN</samp>’ = <code>po(9.5, 6)</code>, by global <a href="#FollowAction">FollowAction</a>

13462

</li></ul>

13463

13464

13465

13466

13467

13468

13469

13470

13471

13472

13473

13474

13475

13476

13477

13478

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

13479

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

13480

13481

</tr></table>

13482

13483

<h3 class="subsection">6.3.15 map read directions</h3>

13484

13485

Constants for map read directions (see <a href="#drawMap">drawMap</a>) and map transformations (see

13486

<a href="#Rotating-and-Mirroring-Maps">Rotating and Mirroring Maps</a> and <a href="#Map-Transformation">Map Transformation</a>). They

13487

are not numbers, to allow advanced operations on them when libmap is loaded, see

13488

<a href="#Map-Transformation-Composition-and-Powers">Map Transformation Composition and Powers</a>.

13489

13490

<ul>

13491

<li> ‘<samp>MAP_IDENT</samp>’ = no transformation

13492

</li><li> ‘<samp>MAP_ROT_CW</samp>’ = rotate map 90 degrees clockwise

13493

</li><li> ‘<samp>MAP_ROT_180</samp>’ = rotate map 180 degrees

13494

</li><li> ‘<samp>MAP_ROT_CCW</samp>’ = rotate map 90 degrees counter-clockwise

13495

</li><li> ‘<samp>MAP_FLIP_BACKSLASH</samp>’ = flip upper-left and lower-right corners

13496

</li><li> ‘<samp>MAP_FLIP_HORIZONTAL</samp>’ = flip right and left

13497

</li><li> ‘<samp>MAP_FLIP_SLASH</samp>’ = flip upper-right and lower-left corners

13498

</li><li> ‘<samp>MAP_FLIP_VERTICAL</samp>’ = flip up and down

13499

</li></ul>

13500

13501

Because map transformations are not numbers, you may not safe them as

13502

attributes of objects. Instead, you have to use ‘<samp>index</samp>’ and

13503

‘<samp>MAP_ALL</samp>’, see <a href="#Map-Transformation-Index-and-MAP_005fALL">Map Transformation Index and MAP_ALL</a>.

13504

13505

13506

13507

13508

13509

13510

13511

13512

13513

13514

13515

13516

13517

13518

13519

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

13520

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

13521

13522

</tr></table>

13523

13524

<h2 class="section">6.4 Global Attributes</h2>

13525

13526

13527

<tr><td align="left" valign="top"><a href="#ActorimpulseStrength">6.4.1 ActorimpulseStrength</a></td><td>  </td><td align="left" valign="top">

13528

</td></tr>

13529

<tr><td align="left" valign="top"><a href="#AllowSingleOxyds">6.4.2 AllowSingleOxyds</a></td><td>  </td><td align="left" valign="top">

13530

</td></tr>

13531

<tr><td align="left" valign="top"><a href="#AllowSuicide">6.4.3 AllowSuicide</a></td><td>  </td><td align="left" valign="top">

13532

</td></tr>

13533

<tr><td align="left" valign="top"><a href="#AutoRespawn">6.4.4 AutoRespawn</a></td><td>  </td><td align="left" valign="top">

13534

</td></tr>

13535

<tr><td align="left" valign="top"><a href="#ConserveLevel">6.4.5 ConserveLevel</a></td><td>  </td><td align="left" valign="top">

13536

</td></tr>

13537

<tr><td align="left" valign="top"><a href="#CrackSpreading">6.4.6 CrackSpreading</a></td><td>  </td><td align="left" valign="top">

13538

</td></tr>

13539

<tr><td align="left" valign="top"><a href="#CreatingPreview">6.4.7 CreatingPreview</a></td><td>  </td><td align="left" valign="top">

13540

</td></tr>

13541

<tr><td align="left" valign="top"><a href="#ElectricStrength">6.4.8 ElectricStrength</a></td><td>  </td><td align="left" valign="top">

13542

</td></tr>

13543

<tr><td align="left" valign="top"><a href="#ExtralifeGlasses">6.4.9 ExtralifeGlasses</a></td><td>  </td><td align="left" valign="top">

13544

</td></tr>

13545

<tr><td align="left" valign="top"><a href="#FallenPuzzle">6.4.10 FallenPuzzle</a></td><td>  </td><td align="left" valign="top">

13546

</td></tr>

13547

<tr><td align="left" valign="top"><a href="#FollowAction">6.4.11 FollowAction</a></td><td>  </td><td align="left" valign="top">

13548

</td></tr>

13549

<tr><td align="left" valign="top"><a href="#FollowGrid">6.4.12 FollowGrid</a></td><td>  </td><td align="left" valign="top">

13550

</td></tr>

13551

<tr><td align="left" valign="top"><a href="#FollowMethod">6.4.13 FollowMethod</a></td><td>  </td><td align="left" valign="top">

13552

</td></tr>

13553

<tr><td align="left" valign="top"><a href="#FollowThreshold">6.4.14 FollowThreshold</a></td><td>  </td><td align="left" valign="top">

13554

</td></tr>

13555

<tr><td align="left" valign="top"><a href="#Fragility">6.4.15 Fragility</a></td><td>  </td><td align="left" valign="top">

13556

</td></tr>

13557

<tr><td align="left" valign="top"><a href="#FrictionStrength">6.4.16 FrictionStrength</a></td><td>  </td><td align="left" valign="top">

13558

</td></tr>

13559

<tr><td align="left" valign="top"><a href="#GlobalForce">6.4.17 GlobalForce</a></td><td>  </td><td align="left" valign="top">

13560

</td></tr>

13561

<tr><td align="left" valign="top"><a href="#Height">6.4.18 Height</a></td><td>  </td><td align="left" valign="top">

13562

</td></tr>

13563

<tr><td align="left" valign="top"><a href="#InfiniteReincarnation">6.4.19 InfiniteReincarnation</a></td><td>  </td><td align="left" valign="top">

13564

</td></tr>

13565

<tr><td align="left" valign="top"><a href="#IsDifficult">6.4.20 IsDifficult</a></td><td>  </td><td align="left" valign="top">

13566

</td></tr>

13567

<tr><td align="left" valign="top"><a href="#MagnetRange">6.4.21 MagnetRange</a></td><td>  </td><td align="left" valign="top">

13568

</td></tr>

13569

<tr><td align="left" valign="top"><a href="#MagnetStrength">6.4.22 MagnetStrength</a></td><td>  </td><td align="left" valign="top">

13570

</td></tr>

13571

<tr><td align="left" valign="top"><a href="#MaxOxydColor">6.4.23 MaxOxydColor</a></td><td>  </td><td align="left" valign="top">

13572

</td></tr>

13573

<tr><td align="left" valign="top"><a href="#MeditationStrength">6.4.24 MeditationStrength</a></td><td>  </td><td align="left" valign="top">

13574

</td></tr>

13575

<tr><td align="left" valign="top"><a href="#ProvideExtralifes">6.4.25 ProvideExtralifes</a></td><td>  </td><td align="left" valign="top">

13576

</td></tr>

13577

<tr><td align="left" valign="top"><a href="#RubberViolationStrength">6.4.26 RubberViolationStrength</a></td><td>  </td><td align="left" valign="top">

13578

</td></tr>

13579

<tr><td align="left" valign="top"><a href="#ShowMoves">6.4.27 ShowMoves</a></td><td>  </td><td align="left" valign="top">

13580

</td></tr>

13581

<tr><td align="left" valign="top"><a href="#SlopeStrength">6.4.28 SlopeStrength</a></td><td>  </td><td align="left" valign="top">

13582

</td></tr>

13583

<tr><td align="left" valign="top"><a href="#SublevelNumber">6.4.29 SublevelNumber</a></td><td>  </td><td align="left" valign="top">

13584

</td></tr>

13585

<tr><td align="left" valign="top"><a href="#SublevelTitle">6.4.30 SublevelTitle</a></td><td>  </td><td align="left" valign="top">

13586

</td></tr>

13587

<tr><td align="left" valign="top"><a href="#SubSoil">6.4.31 SubSoil</a></td><td>  </td><td align="left" valign="top">

13588

</td></tr>

13589

<tr><td align="left" valign="top"><a href="#SurviveFinish">6.4.32 SurviveFinish</a></td><td>  </td><td align="left" valign="top">

13590

</td></tr>

13591

<tr><td align="left" valign="top"><a href="#SwampSinkTime">6.4.33 SwampSinkTime</a></td><td>  </td><td align="left" valign="top">

13592

</td></tr>

13593

<tr><td align="left" valign="top"><a href="#WaterSinkTime">6.4.34 WaterSinkTime</a></td><td>  </td><td align="left" valign="top">

13594

</td></tr>

13595

<tr><td align="left" valign="top"><a href="#Width">6.4.35 Width</a></td><td>  </td><td align="left" valign="top">

13596

</td></tr>

13597

<tr><td align="left" valign="top"><a href="#WormholeRange">6.4.36 WormholeRange</a></td><td>  </td><td align="left" valign="top">

13598

</td></tr>

13599

<tr><td align="left" valign="top"><a href="#WormholeStrength">6.4.37 WormholeStrength</a></td><td>  </td><td align="left" valign="top">

13600

</td></tr>

13601

</table>

13602

13603

13604

13605

13606

13607

13608

13609

13610

13611

13612

13613

13614

13615

13616

13617

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

13618

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

13619

13620

</tr></table>

13621

13622

<h3 class="subsection">6.4.1 ActorimpulseStrength</h3>

13623

13624

A global scalar default factor for the actorimpulse stone bumping force. This

13625

global value is only used if no object specific value is set.

13626

13627

13628

<dt> Type:   number</dt>

13629

<dt> Values:   float number</dt>

13630

<dt> Default:   <code>+200.0</code></dt>

13631

<dt> Access:   read/write</dt>

13632

<dt> Support:   <a href="#st_005factorimpulse">st_actorimpulse</a></dt>

13633

</dl>

13634

13635

13636

13637

13638

13639

13640

13641

13642

13643

13644

13645

13646

13647

13648

13649

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

13650

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

13651

13652

</tr></table>

13653

13654

<h3 class="subsection">6.4.2 AllowSingleOxyds</h3>

13655

13656

A global variable that enables the existence of single unmatched <a href="#st_005foxyd">st_oxyd</a>

13657

stones. Setting this variable to <code>true</code> allows you to set uneven numbers

13658

of oxyd stones for fixed colors. If a level deletes or adds oxyd stones during

13659

runtime a <code>true</code> value avoids possible problems due to temporary uneven

13660

oxyd stone numbers. The default <code>false</code> value causes an error message on

13661

detection of uneven oxyd numbers.

13662

13663

13664

13665

<dt> Values:   <code>true</code>, <code>false</code></dt>

13666

<dt> Default:   <code>false</code></dt>

13667

<dt> Access:   read/write</dt>

13668

<dt> Support:   <a href="#st_005foxyd">st_oxyd</a></dt>

13669

</dl>

13670

13671

13672

13673

13674

13675

13676

13677

13678

13679

13680

13681

13682

13683

13684

13685

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

13686

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

13687

13688

</tr></table>

13689

13690

<h3 class="subsection">6.4.3 AllowSuicide</h3>

13691

13692

A global variable that enables the user to commit suicide with all owned

13693

actors by pressing ‘<samp>F3</samp>’. As this legacy feature can cause unexpected

13694

shortcuts, you can deny this freedom. A single actor suicide as committed by

13695

activation of an <a href="#it_005fspoon">it_spoon</a> is not affected by this global variable.

13696

13697

13698

13699

<dt> Values:   <code>true</code>, <code>false</code></dt>

13700

<dt> Default:   <code>true</code></dt>

13701

<dt> Access:   read/write</dt>

13702

<dt> Support:   no object</dt>

13703

</dl>

13704

13705

13706

13707

13708

13709

13710

13711

13712

13713

13714

13715

13716

13717

13718

13719

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

13720

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

13721

13722

</tr></table>

13723

13724

<h3 class="subsection">6.4.4 AutoRespawn</h3>

13725

13726

A global variable that determines, if in absence of an <a href="#it_005fflag">it_flag</a> drop given

13727

respawn position, the last recorded secure actor position should be taken

13728

instead of the starting position, in case the actor dies and is resurrected.

13729

13730

The recorded auto respawn position will be appropriate for common actor deaths

13731

like sinking in <a href="#fl_005fwater">fl_water</a>, falling into <a href="#fl_005fabyss">fl_abyss</a>, hitting of

13732

<a href="#st_005fdeath">st_death</a>, slipping from an <a href="#it_005fstrip">it_strip</a>, being hit by an

13733

<a href="#it_005flaserbeam">it_laserbeam</a>. Even a jump into one these lethal destinations resurrects

13734

the actor onto the position from where the actor started its jump. There is no

13735

danger of being resurrected on floors without <a href="#adhesion-_0028floor_0029">adhesion (floor)</a>.

13736

13737

The usage of <a href="#it_005fflag">it_flag</a> in combination with AutoRespawn is fully supported.

13738

On drop of a flag, the flag position remains the valid respawn position until

13739

a flag is picked up. After a pickup of the flag, what delete the flag defined

13740

position the AutoRespawn position gets active until a flag is dropped again.

13741

13742

Deaths caused by actor collisions, <a href="#it_005fcrack">it_crack</a> and floor shattering

13743

explosions can lead to leathal AutoRespawn positions. Either avoid setting

13744

AutoRespawn to <code>true</code> in such cases or provide an <a href="#it_005fflag">it_flag</a> in such

13745

cases.

13746

13747

Shortcuts introduced by AutoRespawn are unlikely, but not generally impossible.

13748

13749

13750

13751

<dt> Values:   <code>true</code>, <code>false</code></dt>

13752

<dt> Default:   <code>false</code></dt>

13753

<dt> Access:   read/write</dt>

13754

<dt> Support:   <a href="#ac_005fmarble">ac_marble</a>, <a href="#ac_005fpearl">ac_pearl</a></dt>

13755

</dl>

13756

13757

13758

13759

13760

13761

13762

13763

13764

13765

13766

13767

13768

13769

13770

13771

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

13772

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

13773

13774

</tr></table>

13775

13776

<h3 class="subsection">6.4.5 ConserveLevel</h3>

13777

13778

A global variable that determines if a dead actor will be resurrected in case of

13779

<a href="#it_005fextralife">it_extralife</a>s in the gamer’s inventory.

13780

13781

If <code>true</code>, dead actors attached to a player will be resurrected as long as

13782

extralifes are available. If a player has no living actor to control or is

13783

missing the actor’s <a href="#essential">essential</a> constraints, the player is

13784

dead. The level may still continue if a second player is alive. If the gamer has

13785

an <a href="#it_005fyinyang">it_yinyang</a> in his inventory in single user mode, the control switches

13786

to the second player. If all players are dead, a new level game is started.

13787

13788

If the conserve mode is <code>false</code>, no actors will be resurrected. As soon as

13789

the player is dead and the control cannot switch to another player, all dead

13790

actors are resurrected by using extralifes, and the level is restarted without

13791

finishing the level game.

13792

13793

Use <code>false</code> if the level can either be not solved in case of resurrected

13794

actors or would provide a major shortcut. In all other cases, mode <code>true</code>

13795

with proper usage of actors <a href="#essential">essential</a> constraints will be preferable.

13796

13797

13798

13799

<dt> Values:   <code>true</code>, <code>false</code></dt>

13800

<dt> Default:   <code>true</code></dt>

13801

<dt> Access:   read/write</dt>

13802

<dt> Support:   no objects</dt>

13803

</dl>

13804

13805

13806

13807

13808

13809

13810

13811

13812

13813

13814

13815

13816

13817

13818

13819

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

13820

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

13821

13822

</tr></table>

13823

13824

<h3 class="subsection">6.4.6 CrackSpreading</h3>

13825

13826

A global default value denoting the probability that a brittle floor plate, that

13827

is a floor with an <a href="#it_005fcrack">it_crack</a> on top, causes direct neighboring floors to

13828

either be marked with an invisible crack or to toggle such invisible cracks to

13829

a small visible cracks. A value of <code>1.0</code> ensures that the crack spreads to

13830

the direct neighbors, a value of <code>0.0</code> prohibits the spreading to neighbor

13831

grids. Note that even if crack spreading is prohibited, existing cracks on

13832

neighbor grids may continue disintegrating due to their <a href="#Fragility">Fragility</a>. For

13833

more details see <a href="#it_005fcrack">it_crack</a>.

13834

13835

13836

<dt> Type:   number</dt>

13837

<dt> Values:   float number between <code>0.0</code> and <code>1.0</code></dt>

13838

<dt> Default:   <code>0.5</code></dt>

13839

<dt> Access:   read/write</dt>

13840

<dt> Support:   <a href="#it_005fcrack">it_crack</a></dt>

13841

</dl>

13842

13843

13844

13845

13846

13847

13848

13849

13850

13851

13852

13853

13854

13855

13856

13857

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

13858

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

13859

13860

</tr></table>

13861

13862

<h3 class="subsection">6.4.7 CreatingPreview</h3>

13863

13864

A global read only variable that indicates if the current level load is just for

13865

creating a preview thumbnail of the level or a real game play. If ‘<samp>true</samp>’,

13866

you can, e.g., change the start-position of the main actor to display another

13867

part of the level in the preview, or hide objects from it. When changing the

13868

initial position, it might be advantageous to also set the

13869

<a href="#Display-Follow-Strategy">Display Follow Strategy</a> to permanent smooth scrolling:

13870

13871

<table><tr><td> </td><td><pre class="example">if wo["CreatingPreview"] then

13872

wo["FollowGrid"] = false

13873

wo["FollowMethod"] = FOLLOW_SCROLL

13874

end

13875

</pre></td></tr></table>

13876

13877

13878

13879

<dt> Values:   <code>true</code>, <code>false</code></dt>

13880

<dt> Default:   <code>false</code></dt>

13881

<dt> Access:   read only</dt>

13882

<dt> Support:   object independent</dt>

13883

</dl>

13884

13885

13886

13887

13888

13889

13890

13891

13892

13893

13894

13895

13896

13897

13898

13899

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

13900

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

13901

13902

</tr></table>

13903

13904

<h3 class="subsection">6.4.8 ElectricStrength</h3>

13905

13906

A global scalar default factor for electrical forces. Positive numbers result in

13907

attracting forces for opposite charges and repelling forces for equal signed

13908

charges. Where as negative numbers result in repelling forces for opposite

13909

charges and attracting forces for equal signed charges. This global value is

13910

always multiplied by the charge load of the affected actors. The actor’s charge

13911

load usually results from hits of <a href="#st_005fcharge">st_charge</a>.

13912

13913

13914

<dt> Type:   number</dt>

13915

<dt> Values:   float number</dt>

13916

<dt> Default:   <code>15.0</code></dt>

13917

<dd>Positive number are attracting, negative numbers are repelling.

13918

</dd>

13919

<dt> Access:   read/write</dt>

13920

<dt> Support:   <a href="#Actor-Objects">Actor Objects</a></dt>

13921

</dl>

13922

13923

13924

13925

13926

13927

13928

13929

13930

13931

13932

13933

13934

13935

13936

13937

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

13938

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

13939

13940

</tr></table>

13941

13942

<h3 class="subsection">6.4.9 ExtralifeGlasses</h3>

13943

13944

A global variable that defines the <a href="#it_005fglasses">it_glasses</a> type that is generated on

13945

the laser light conversion of an <a href="#it_005fextralife">it_extralife</a>

13946

13947

13948

<dt> Type:   number</dt>

13949

<dt> Values:   positive integer number</dt>

13950

<dd>A sum out of the constants ‘<samp>SPOT_DEATH</samp>’, ‘<samp>SPOT_HOLLOW</samp>’,

13951

‘<samp>SPOT_ACTORIMPULSE</samp>’, ‘<samp>SPOT_SENSOR</samp>’, ‘<samp>SPOT_LIGHTPASSENGER</samp>’,

13952

‘<samp>SPOT_TRAP</samp>’

13953

</dd>

13954

<dt> Default:   <code>SPOT_DEATH + SPOT_HOLLOW + SPOT_LIGHTPASSENGER</code></dt>

13955

<dt> Access:   read/write</dt>

13956

<dt> Support:   <a href="#it_005fextralife">it_extralife</a></dt>

13957

</dl>

13958

13959

13960

13961

13962

13963

13964

13965

13966

13967

13968

13969

13970

13971

13972

13973

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

13974

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

13975

13976

</tr></table>

13977

13978

<h3 class="subsection">6.4.10 FallenPuzzle</h3>

13979

13980

A global object replacement kind for <a href="#st_005fpuzzle">st_puzzle</a>s fallen into <a href="#fl_005fwater">fl_water</a>

13981

or <a href="#fl_005fabyss">fl_abyss</a>. Besides any floor kind you can use any key of a tile

13982

declaration preceeded by an equal sign <code>'='</code>. By this second method you

13983

can use attributed floor kinds with special values for friction and adhesion.

13984

13985

Additionally you can set this global ‘<samp>FallenPuzzle</samp>’ attribute to

13986

<code>"it_pipe"</code> or <code>"it_stip"</code>. In both cases fallen puzzle objects will

13987

be replaced by items of the given class with the identical connections as the

13988

fallen puzzle stones. Just in case that an item of the given class is already

13989

present at one of the affected grid positions the connections of these will be

13990

adjusted in a special way. An existing <code>"it_pipe"</code> remains unchanged, but

13991

an <code>"it_stip"</code> will add the connections of the fallen puzzle to its own

13992

connections.

13993

13994

13995

<dt> Type:   string</dt>

13996

<dt> Values:   any floor object kind, <code>"it_strip"</code>, <code>"it_pipe"</code> or <code>"=key"</code>, with key being a valid tile key</dt>

13997

<dt> Default:   <code>"fl_gray"</code></dt>

13998

<dt> Access:   read/write</dt>

13999

<dt> Support:   <a href="#st_005fpuzzle">st_puzzle</a></dt>

14000

</dl>

14001

14002

14003

14004

14005

14006

14007

14008

14009

14010

14011

14012

14013

14014

14015

14016

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14017

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14018

14019

</tr></table>

14020

14021

<h3 class="subsection">6.4.11 FollowAction</h3>

14022

14023

A global variable that describes the action of the display on relocation. This

14024

attribute is introduced for future extensions, but is currently just partially

14025

supported. Just the values listed below are used. Please use this attribute

14026

just as explained in <a href="#Display-Follow-Strategy">Display Follow Strategy</a>.

14027

14028

14029

<dt> Type:   number or position</dt>

14030

<dt> Values:   <code>0</code>, <code>FOLLOW_FULLSCREEN</code>, <code>HALFSCREEN</code></dt>

14031

<dd>The distance of display readjustment. Positions are used to supply different

14032

values for x and y. The value ‘<samp>{19, 12}</samp>’ is a standard full screen move.

14033

The value ‘<samp>{9.5, 6}</samp>’ is a standard half screen move. A value ‘<samp>0</samp>’

14034

is a minimal smooth move or the default value for grid based moves.

14035

</dd>

14036

<dt> Default:   <code>{19, 12}</code></dt>

14037

<dd>Actually the default is mode based (see section <a href="#Display-Follow-Strategy">Display Follow Strategy</a>).

14038

</dd>

14039

<dt> Access:   read/write</dt>

14040

<dt> Support:   no objects</dt>

14041

</dl>

14042

14043

14044

14045

14046

14047

14048

14049

14050

14051

14052

14053

14054

14055

14056

14057

14058

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14059

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14060

14061

</tr></table>

14062

14063

<h3 class="subsection">6.4.12 FollowGrid</h3>

14064

14065

A global variable that determines if the display is fixed in its static

14066

positions to grids or if it can be scrolled to any pixel position

14067

(see section <a href="#Display-Follow-Strategy">Display Follow Strategy</a>).

14068

14069

14070

14071

<dt> Values:   <code>true</code>, <code>false</code></dt>

14072

<dt> Default:   <code>true</code></dt>

14073

<dt> Access:   read/write</dt>

14074

<dt> Support:   no objects</dt>

14075

</dl>

14076

14077

14078

14079

14080

14081

14082

14083

14084

14085

14086

14087

14088

14089

14090

14091

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14092

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14093

14094

</tr></table>

14095

14096

<h3 class="subsection">6.4.13 FollowMethod</h3>

14097

14098

A global variable that describes the method how the display moves, either not

14099

at all, by pixelwise scrolling, or by flipping to another screen or region

14100

(see section <a href="#Display-Follow-Strategy">Display Follow Strategy</a>).

14101

14102

14103

<dt> Type:   number</dt>

14104

<dt> Values:   <code>FOLLOW_NO</code>, <code>FOLLOW_SCROLL</code>, <code>FOLLOW_FLIP</code></dt>

14105

<dt> Default:   <code>FOLLOW_FLIP</code></dt>

14106

<dt> Access:   read/write</dt>

14107

<dt> Support:   no objects</dt>

14108

</dl>

14109

14110

14111

14112

14113

14114

14115

14116

14117

14118

14119

14120

14121

14122

14123

14124

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14125

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14126

14127

</tr></table>

14128

14129

<h3 class="subsection">6.4.14 FollowThreshold</h3>

14130

14131

A global variable that describes the threshold at which a crossing active marble

14132

triggers the display to relocate. It is given as the distance to the screen

14133

boundary (see section <a href="#Display-Follow-Strategy">Display Follow Strategy</a>).

14134

14135

14136

<dt> Type:   number or position</dt>

14137

<dt> Values:   0 or positive number, or a pair of two positive numbers</dt>

14138

<dd>The distance from the screen boundary at which the displays readjusts. Positions

14139

are used to supply different values for x and y. All values need to be less

14140

than half of the screen size.

14141

</dd>

14142

<dt> Default:   <code>0.5</code></dt>

14143

<dt> Access:   read/write</dt>

14144

<dt> Support:   no objects</dt>

14145

</dl>

14146

14147

14148

14149

14150

14151

14152

14153

14154

14155

14156

14157

14158

14159

14160

14161

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14162

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14163

14164

</tr></table>

14165

14166

<h3 class="subsection">6.4.15 Fragility</h3>

14167

14168

A global default value denoting the probability that a brittle floor plate, that

14169

is a floor with an <a href="#it_005fcrack">it_crack</a> on top, continues to disintegrate on events

14170

like an actor entering, passing a neighboring <a href="#it_005fcrack">it_crack</a>, nearby explosions

14171

or fire heating. A value of <code>1.0</code> ensures that the crack continues to

14172

disintegrates on these events, a value of <code>0.0</code> prohibits visible cracks

14173

to get larger. This default is superseded by <a href="#fragility-_0028floor_0029">fragility (floor)</a> and

14174

<a href="#it_005fcrack">it_crack</a> specific values.

14175

14176

14177

<dt> Type:   number</dt>

14178

<dt> Values:   float number between <code>0.0</code> and <code>1.0</code></dt>

14179

<dt> Default:   <code>1.0</code></dt>

14180

<dt> Access:   read/write</dt>

14181

<dt> Support:   <a href="#it_005fcrack">it_crack</a> and <a href="#Floor-Objects">Floor Objects</a></dt>

14182

</dl>

14183

14184

14185

14186

14187

14188

14189

14190

14191

14192

14193

14194

14195

14196

14197

14198

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14199

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14200

14201

</tr></table>

14202

14203

<h3 class="subsection">6.4.16 FrictionStrength</h3>

14204

14205

A global scalar default factor for floor friction values. This global value is

14206

always multiplied by the floor specific friction on calculation of the friction

14207

force applied to actors.

14208

14209

14210

<dt> Type:   number</dt>

14211

<dt> Values:   float number</dt>

14212

<dt> Default:   <code>1.0</code></dt>

14213

<dt> Access:   read/write</dt>

14214

<dt> Support:   all floors</dt>

14215

</dl>

14216

14217

14218

14219

14220

14221

14222

14223

14224

14225

14226

14227

14228

14229

14230

14231

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14232

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14233

14234

</tr></table>

14235

14236

<h3 class="subsection">6.4.17 GlobalForce</h3>

14237

14238

A global constant force that is added to every actor on every grid. The force

14239

is given as a vector constant by a value of type <a href="#Position">Position</a>.

14240

14241

14242

<dt> Type:   <a href="#Position">Position</a></dt>

14243

<dt> Values:   pair of float numbers</dt>

14244

<dt> Default:   <code>po(0.0, 0.0)</code></dt>

14245

<dt> Access:   read/write</dt>

14246

<dt> Support:   all floors</dt>

14247

</dl>

14248

14249

14250

14251

14252

14253

14254

14255

14256

14257

14258

14259

14260

14261

14262

14263

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14264

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14265

14266

</tr></table>

14267

14268

<h3 class="subsection">6.4.18 Height</h3>

14269

14270

A global read only variable reports the height of the world in grid units.

14271

This is set by the initial world constructor call

14272

(see section <a href="#World-Creation">World Creation</a>).

14273

14274

14275

<dt> Type:   number</dt>

14276

<dt> Values:   positive integer number</dt>

14277

<dt> Default:   <code>?</code></dt>

14278

<dt> Access:   read only</dt>

14279

<dt> Support:   object independent</dt>

14280

</dl>

14281

14282

14283

14284

14285

14286

14287

14288

14289

14290

14291

14292

14293

14294

14295

14296

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14297

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14298

14299

</tr></table>

14300

14301

<h3 class="subsection">6.4.19 InfiniteReincarnation</h3>

14302

14303

A global variable that switches off the <a href="#it_005fextralife">it_extralife</a> consumption on

14304

resurrection of a dead actor. Usually the number of extralifes is counted,

14305

the items are explicitly set or an <a href="#st_005fdispenser">st_dispenser</a> for extralifes is located

14306

at strategic positions. The main purpose of this flag is the support of easy

14307

modes for very lethal levels, that should give the user the opportunity to

14308

exercise difficult patterns. Usage of this flag for the regular difficult mode

14309

is deprecated.

14310

14311

14312

14313

<dt> Values:   <code>true</code>, <code>false</code></dt>

14314

<dt> Default:   <code>false</code></dt>

14315

<dt> Access:   read/write</dt>

14316

<dt> Support:   object independent</dt>

14317

</dl>

14318

14319

14320

14321

14322

14323

14324

14325

14326

14327

14328

14329

14330

14331

14332

14333

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14334

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14335

14336

</tr></table>

14337

14338

<h3 class="subsection">6.4.20 IsDifficult</h3>

14339

14340

A global read only variable that defines the current difficulty mode selected

14341

by the user. All differences of easy and difficult mode within the level should

14342

be coded solely in dependence of this flag. If a level that supports an easy

14343

mode the author needs to declare it in the XML header in the element

14344

<a href="#g_t_003cmodes_003e"><modes></a>.

14345

14346

14347

14348

<dt> Values:   <code>true</code>, <code>false</code></dt>

14349

<dt> Default:   <code>true</code></dt>

14350

<dt> Access:   read only</dt>

14351

<dt> Support:   object independent</dt>

14352

</dl>

14353

14354

14355

14356

14357

14358

14359

14360

14361

14362

14363

14364

14365

14366

14367

14368

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14369

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14370

14371

</tr></table>

14372

14373

<h3 class="subsection">6.4.21 MagnetRange</h3>

14374

14375

A global default distance up to which magnets apply forces to actors. This

14376

global value is only used if no object specific value is set.

14377

14378

14379

<dt> Type:   number</dt>

14380

<dt> Values:   positive float number or zero</dt>

14381

<dt> Default:   <code>10.0</code></dt>

14382

<dt> Access:   read/write</dt>

14383

<dt> Support:   <a href="#it_005fmagnet">it_magnet</a></dt>

14384

</dl>

14385

14386

14387

14388

14389

14390

14391

14392

14393

14394

14395

14396

14397

14398

14399

14400

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14401

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14402

14403

</tr></table>

14404

14405

<h3 class="subsection">6.4.22 MagnetStrength</h3>

14406

14407

A global scalar default factor for magnet forces. Positive numbers are

14408

attracting forces where as negative numbers are repelling forces. This global

14409

value is only used if no object specific value is set.

14410

14411

14412

<dt> Type:   number</dt>

14413

<dt> Values:   float number</dt>

14414

<dt> Default:   <code>30.0</code></dt>

14415

<dd>Positive number are attracting, negative numbers are repelling.

14416

</dd>

14417

<dt> Access:   read/write</dt>

14418

<dt> Support:   <a href="#it_005fmagnet">it_magnet</a></dt>

14419

</dl>

14420

14421

14422

14423

14424

14425

14426

14427

14428

14429

14430

14431

14432

14433

14434

14435

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14436

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14437

14438

</tr></table>

14439

14440

<h3 class="subsection">6.4.23 MaxOxydColor</h3>

14441

14442

A global variable that limits the number of colors assigned to autocolored

14443

<a href="#st_005foxyd">st_oxyd</a>. Be careful with increasing this value beyond its default.

14444

14445

14446

<dt> Type:   number</dt>

14447

<dt> Values:   <code>OXYD_BLUE</code>, ... <code>OXYD_BROWN</code></dt>

14448

<dt> Default:   <code>OXYD_BLACK</code></dt>

14449

<dt> Access:   read/write</dt>

14450

<dt> Support:   <a href="#st_005foxyd">st_oxyd</a></dt>

14451

</dl>

14452

14453

14454

14455

14456

14457

14458

14459

14460

14461

14462

14463

14464

14465

14466

14467

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14468

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14469

14470

</tr></table>

14471

14472

<h3 class="subsection">6.4.24 MeditationStrength</h3>

14473

14474

A global scalar default factor for <a href="#it_005fmeditation">it_meditation</a> slope forces. Positive

14475

numbers are downhill forces that let actors roll into dents and hollows and roll

14476

down from hills and bumps.

14477

14478

14479

<dt> Type:   number</dt>

14480

<dt> Values:   float number</dt>

14481

<dt> Default:   <code>1.0</code></dt>

14482

<dt> Access:   read/write</dt>

14483

<dt> Support:   <a href="#it_005fmeditation">it_meditation</a></dt>

14484

</dl>

14485

14486

14487

14488

14489

14490

14491

14492

14493

14494

14495

14496

14497

14498

14499

14500

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14501

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14502

14503

</tr></table>

14504

14505

<h3 class="subsection">6.4.25 ProvideExtralifes</h3>

14506

14507

A global variable that causes two <a href="#it_005fextralife">it_extralife</a>s to be added to both player

14508

inventories on start of a new level. Set it to ‘<samp>false</samp>’ if a gamer could

14509

misuse these items. It is important to set this attribute before the world is

14510

created (see section <a href="#World-Creation">World Creation</a>).

14511

14512

14513

14514

<dt> Values:   <code>true</code>, <code>false</code></dt>

14515

<dt> Default:   <code>true</code></dt>

14516

<dt> Access:   read/write</dt>

14517

<dt> Support:   object independent</dt>

14518

</dl>

14519

14520

14521

14522

14523

14524

14525

14526

14527

14528

14529

14530

14531

14532

14533

14534

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14535

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14536

14537

</tr></table>

14538

14539

<h3 class="subsection">6.4.26 RubberViolationStrength</h3>

14540

14541

A global scalar default factor for the <a href="#ot_005frubberband">ot_rubberband</a> force that is applied

14542

to actors if the length of the rubberband exceeds the given min or max limits.

14543

This can happen due to extraordinary events like actor warping, actor

14544

resurrection, moving anchor stones or simply new rubberbands that are created

14545

with off limit length.

14546

14547

14548

<dt> Type:   number</dt>

14549

<dt> Values:   positive float number</dt>

14550

<dt> Default:   <code>50.0</code></dt>

14551

<dt> Access:   read/write</dt>

14552

<dt> Support:   <a href="#ot_005frubberband">ot_rubberband</a></dt>

14553

</dl>

14554

14555

14556

14557

14558

14559

14560

14561

14562

14563

14564

14565

14566

14567

14568

14569

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14570

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14571

14572

</tr></table>

14573

14574

<h3 class="subsection">6.4.27 ShowMoves</h3>

14575

14576

A global variable that enables or disables the display of the stone push

14577

counter besides the level time. It is mainly used in Sokoban like levels.

14578

14579

14580

14581

<dt> Values:   <code>true</code>, <code>false</code></dt>

14582

<dt> Default:   <code>false</code></dt>

14583

<dt> Access:   read/write</dt>

14584

<dt> Support:   object independent</dt>

14585

</dl>

14586

14587

14588

14589

14590

14591

14592

14593

14594

14595

14596

14597

14598

14599

14600

14601

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14602

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14603

14604

</tr></table>

14605

14606

<h3 class="subsection">6.4.28 SlopeStrength</h3>

14607

14608

A global scalar default factor for <a href="#fl_005fslope">fl_slope</a> floor gradient forces. This

14609

global value is used if no slope object specific strength factor is supplied.

14610

14611

14612

<dt> Type:   number</dt>

14613

<dt> Values:   float number</dt>

14614

<dt> Default:   <code>25.0</code></dt>

14615

<dt> Access:   read/write</dt>

14616

<dt> Support:   <a href="#fl_005fslope">fl_slope</a></dt>

14617

</dl>

14618

14619

14620

14621

14622

14623

14624

14625

14626

14627

14628

14629

14630

14631

14632

14633

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14634

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14635

14636

</tr></table>

14637

14638

<h3 class="subsection">6.4.29 SublevelNumber</h3>

14639

14640

A global variable that is only used by <a href="#Multilevel-Files">Multilevel Files</a>. It contains the

14641

number of the sublevel that should be loaded and played. The number is preset

14642

to a value between <code>1</code> and the ‘<samp>quantity</samp>’ given in the

14643

<a href="#Info-metadata">Info metadata</a>.

14644

14645

14646

14647

<dt> Values:   positive integer numbers</dt>

14648

<dt> Default:   <code>1</code></dt>

14649

<dt> Access:   read only</dt>

14650

<dt> Support:   no objects</dt>

14651

</dl>

14652

14653

14654

14655

14656

14657

14658

14659

14660

14661

14662

14663

14664

14665

14666

14667

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14668

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14669

14670

</tr></table>

14671

14672

<h3 class="subsection">6.4.30 SublevelTitle</h3>

14673

14674

A global variable that is only used by <a href="#Multilevel-Files">Multilevel Files</a>. If the sublevel

14675

provides an individual title this variable must be set on level load to the

14676

title string. An empty string value causes an auto generated title based on

14677

the title given in the <a href="#g_t_003cidentity_003e"><identity></a> element and the <a href="#SublevelNumber">SublevelNumber</a>.

14678

14679

14680

<dt> Type:   string</dt>

14681

<dt> Values:   any string</dt>

14682

<dt> Default:   <code>""</code></dt>

14683

<dt> Access:   read/write</dt>

14684

<dt> Support:   no objects</dt>

14685

</dl>

14686

14687

14688

14689

14690

14691

14692

14693

14694

14695

14696

14697

14698

14699

14700

14701

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14702

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14703

14704

</tr></table>

14705

14706

<h3 class="subsection">6.4.31 SubSoil</h3>

14707

14708

A global variable that defines the subsoil which replaces a floor on its

14709

physical destruction. <a href="#it_005fbomb">it_bomb</a>s and <a href="#ot_005fcannonball">ot_cannonball</a>s can cause

14710

<a href="#it_005fexplosion">it_explosion</a>_debris which in turn dissolves the floor to the base

14711

subsoil. The special value <code>SUBSOIL_AUTO</code> determines the subsoil based

14712

on the surrounding floors. Any <a href="#fl_005fwater">fl_water</a> on a direct neighboring floor

14713

causes the floor to be replaced by water, too. Otherwise the default

14714

<a href="#fl_005fabyss">fl_abyss</a> will be used as replacement.

14715

14716

14717

14718

<dt> Values:   <code>SUBSOIL_ABYSS</code>, <code>SUBSOIL_WATER</code>, <code>SUBSOIL_AUTO</code></dt>

14719

<dt> Default:   <code>SUBSOIL_ABYSS</code></dt>

14720

<dt> Access:   read/write</dt>

14721

<dt> Support:   <a href="#it_005fexplosion">it_explosion</a></dt>

14722

</dl>

14723

14724

14725

14726

14727

14728

14729

14730

14731

14732

14733

14734

14735

14736

14737

14738

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14739

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14740

14741

</tr></table>

14742

14743

<h3 class="subsection">6.4.32 SurviveFinish</h3>

14744

14745

A global variable that defines if the essential actors have to survive the

14746

finish of the game (see section <a href="#Ending-Conditions">Ending Conditions</a>). With this attribute set to

14747

‘<samp>false</samp>’ a gamer can sacrifice an essential actor to finish the level in the

14748

same step in some subtle cases.

14749

14750

14751

14752

<dt> Values:   <code>true</code>, <code>false</code></dt>

14753

<dt> Default:   <code>true</code></dt>

14754

<dt> Access:   read/write</dt>

14755

<dt> Support:   object independent</dt>

14756

</dl>

14757

14758

14759

14760

14761

14762

14763

14764

14765

14766

14767

14768

14769

14770

14771

14772

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14773

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14774

14775

</tr></table>

14776

14777

<h3 class="subsection">6.4.33 SwampSinkTime</h3>

14778

14779

A global default for the time it takes a static actor to sink in <a href="#fl_005fswamp">fl_swamp</a>.

14780

Fast moving actors will need slightly more time than static actors.

14781

14782

14783

<dt> Type:   number or <code>nil</code></dt>

14784

<dt> Values:   positive float number or zero or <code>nil</code></dt>

14785

<dd>Sink time in seconds or ‘<samp>nil</samp>’ for an infinite time aka not sinking. Time

14786

values smaller than approximately 0.7 ms will be rounded down to 0 ms.

14787

</dd>

14788

<dt> Default:   <code>1.75</code></dt>

14789

<dt> Access:   read/write</dt>

14790

<dt> Support:   <a href="#fl_005fswamp">fl_swamp</a></dt>

14791

</dl>

14792

14793

14794

14795

14796

14797

14798

14799

14800

14801

14802

14803

14804

14805

14806

14807

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14808

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14809

14810

</tr></table>

14811

14812

<h3 class="subsection">6.4.34 WaterSinkTime</h3>

14813

14814

A global default for the time it takes an actor to sink in <a href="#fl_005fwater">fl_water</a>.

14815

14816

14817

<dt> Type:   number or <code>nil</code></dt>

14818

<dt> Values:   positive float number or zero or <code>nil</code></dt>

14819

<dd>Sink time in seconds or ‘<samp>nil</samp>’ for an infinite time aka not sinking. Time

14820

values smaller than approximately 0.7 ms will be rounded down to 0 ms.

14821

</dd>

14822

<dt> Default:   <code>0.0</code></dt>

14823

<dt> Access:   read/write</dt>

14824

<dt> Support:   <a href="#fl_005fwater">fl_water</a></dt>

14825

</dl>

14826

14827

14828

14829

14830

14831

14832

14833

14834

14835

14836

14837

14838

14839

14840

14841

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14842

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14843

14844

</tr></table>

14845

14846

<h3 class="subsection">6.4.35 Width</h3>

14847

14848

A global read only variable reports the width of the world in grid units.

14849

This is set by the initial world constructor call

14850

(see section <a href="#World-Creation">World Creation</a>).

14851

14852

14853

<dt> Type:   number</dt>

14854

<dt> Values:   positive integer number</dt>

14855

<dt> Default:   <code>?</code></dt>

14856

<dt> Access:   read only</dt>

14857

<dt> Support:   object independent</dt>

14858

</dl>

14859

14860

14861

14862

14863

14864

14865

14866

14867

14868

14869

14870

14871

14872

14873

14874

14875

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14876

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14877

14878

</tr></table>

14879

14880

<h3 class="subsection">6.4.36 WormholeRange</h3>

14881

14882

A global default distance up to which wormholes apply forces to actors. This

14883

global value is only used if no object specific value is set.

14884

14885

14886

<dt> Type:   number</dt>

14887

<dt> Values:   positive float number or zero</dt>

14888

<dt> Default:   <code>10.0</code></dt>

14889

<dt> Access:   read/write</dt>

14890

<dt> Support:   <a href="#it_005fwormhole">it_wormhole</a></dt>

14891

</dl>

14892

14893

14894

14895

14896

14897

14898

14899

14900

14901

14902

14903

14904

14905

14906

14907

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14908

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14909

14910

</tr></table>

14911

14912

<h3 class="subsection">6.4.37 WormholeStrength</h3>

14913

14914

A global scalar default factor for wormhole forces. Positive numbers are

14915

attracting forces where as negative numbers are repelling forces. This global

14916

value is only used if no object specific value is set.

14917

14918

14919

<dt> Type:   number</dt>

14920

<dt> Values:   float number</dt>

14921

<dt> Default:   <code>30.0</code></dt>

14922

<dd>Positive number are attracting, negative numbers are repelling.

14923

</dd>

14924

<dt> Access:   read/write</dt>

14925

<dt> Support:   <a href="#it_005fwormhole">it_wormhole</a></dt>

14926

</dl>

14927

14928

14929

14930

14931

14932

14933

14934

14935

14936

14937

14938

14939

14940

14941

14942

14943

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14944

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14945

14946

</tr></table>

14947

14948

<h1 class="chapter">7. Floor Objects</h1>

14949

14950

14951

<tr><td align="left" valign="top"><a href="#Floor-Overview">7.1 Floor Overview</a></td><td>  </td><td align="left" valign="top">

14952

</td></tr>

14953

<tr><td align="left" valign="top"><a href="#Floor-Attributes">7.2 Floor Attributes</a></td><td>  </td><td align="left" valign="top">

14954

</td></tr>

14955

<tr><td align="left" valign="top"><a href="#Standard-Floors">7.3 Standard Floors</a></td><td>  </td><td align="left" valign="top">

14956

</td></tr>

14957

<tr><td align="left" valign="top"><a href="#Special-Floors">7.4 Special Floors</a></td><td>  </td><td align="left" valign="top">

14958

</td></tr>

14959

</table>

14960

14961

14962

14963

14964

14965

14966

14967

14968

14969

14970

14971

14972

14973

14974

14975

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

14976

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

14977

14978

</tr></table>

14979

14980

<h2 class="section">7.1 Floor Overview</h2>

14981

14982

<table>

14983

<tr><td width="8%"><img src="images/fl_abyss.png" alt="images/fl_abyss"></td><td width="25%"><a href="#fl_005fabyss">fl_abyss</a></td><td width="8%"><img src="images/fl_adhesionless.png" alt="images/fl_adhesionless"></td><td width="25%"><a href="#fl_005fadhesionless">fl_adhesionless</a></td><td width="9%"><img src="images/fl_aquamarine.png" alt="images/fl_aquamarine"></td><td width="25%"><a href="#fl_005faquamarine">fl_aquamarine</a></td></tr>

14984

<tr><td width="8%"><img src="images/fl_bast.png" alt="images/fl_bast"></td><td width="25%"><a href="#fl_005fbast">fl_bast</a></td><td width="8%"><img src="images/fl_bluegray.png" alt="images/fl_bluegray"></td><td width="25%"><a href="#fl_005fbluegray">fl_bluegray</a></td><td width="9%"><img src="images/fl_bluegreen.png" alt="images/fl_bluegreen"></td><td width="25%"><a href="#fl_005fbluegreen">fl_bluegreen</a></td></tr>

14985

<tr><td width="8%"><img src="images/fl_blueslab.png" alt="images/fl_blueslab"></td><td width="25%"><a href="#fl_005fblueslab">fl_blueslab</a></td><td width="8%"><img src="images/fl_brick.png" alt="images/fl_brick"></td><td width="25%"><a href="#fl_005fbrick">fl_brick</a></td><td width="9%"><img src="images/fl_bridge_bw_closed.png" alt="images/fl_bridge_bw_closed"></td><td width="25%"><a href="#fl_005fbridge">fl_bridge</a>_bw</td></tr>

14986

<tr><td width="8%"><img src="images/fl_bridge_gc_closed.png" alt="images/fl_bridge_gc_closed"></td><td width="25%"><a href="#fl_005fbridge">fl_bridge</a>_gc</td><td width="8%"><img src="images/fl_bright.png" alt="images/fl_bright"></td><td width="25%"><a href="#fl_005fbright">fl_bright</a></td><td width="9%"><img src="images/fl_concrete.png" alt="images/fl_concrete"></td><td width="25%"><a href="#fl_005fconcrete">fl_concrete</a></td></tr>

14987

<tr><td width="8%"><img src="images/fl_darkgray.png" alt="images/fl_darkgray"></td><td width="25%"><a href="#fl_005fdarkgray">fl_darkgray</a></td><td width="8%"><img src="images/fl_dark.png" alt="images/fl_dark"></td><td width="25%"><a href="#fl_005fdark">fl_dark</a></td><td width="9%"><img src="images/fl_dunes.png" alt="images/fl_dunes"></td><td width="25%"><a href="#fl_005fdunes">fl_dunes</a></td></tr>

14988

<tr><td width="8%"><img src="images/fl_fake_trigger.png" alt="images/fl_fake_trigger"></td><td width="25%"><a href="#fl_005ffake">fl_fake</a>_trigger</td><td width="8%"><img src="images/fl_gravel.png" alt="images/fl_gravel"></td><td width="25%"><a href="#fl_005fgravel">fl_gravel</a></td><td width="9%"><img src="images/fl_gray.png" alt="images/fl_gray"></td><td width="25%"><a href="#fl_005fgray">fl_gray</a></td></tr>

14989

<tr><td width="8%"><img src="images/fl_hay.png" alt="images/fl_hay"></td><td width="25%"><a href="#fl_005fhay">fl_hay</a></td><td width="8%"><img src="images/fl_himalaya.png" alt="images/fl_himalaya"></td><td width="25%"><a href="#fl_005fhimalaya">fl_himalaya</a></td><td width="9%"><img src="images/fl_ice.png" alt="images/fl_ice"></td><td width="25%"><a href="#fl_005fice">fl_ice</a></td></tr>

14990

<tr><td width="8%"><img src="images/fl_inverse_gray.png" alt="images/fl_inverse_gray"></td><td width="25%"><a href="#fl_005finverse">fl_inverse</a>_gray</td><td width="8%"><img src="images/fl_inverse_white.png" alt="images/fl_inverse_white"></td><td width="25%"><a href="#fl_005finverse">fl_inverse</a>_white</td><td width="9%"><img src="images/fl_ivory.png" alt="images/fl_ivory"></td><td width="25%"><a href="#fl_005fivory">fl_ivory</a></td></tr>

14991

<tr><td width="8%"><img src="images/fl_lawn.png" alt="images/fl_lawn"></td><td width="25%"><a href="#fl_005flawn">fl_lawn</a></td><td width="8%"><img src="images/fl_marble.png" alt="images/fl_marble"></td><td width="25%"><a href="#fl_005fmarble">fl_marble</a></td><td width="9%"><img src="images/fl_metal.png" alt="images/fl_metal"></td><td width="25%"><a href="#fl_005fmetal">fl_metal</a></td></tr>

14992

<tr><td width="8%"><img src="images/fl_mortar.png" alt="images/fl_mortar"></td><td width="25%"><a href="#fl_005fmortar">fl_mortar</a></td><td width="8%"><img src="images/fl_pinkbumps.png" alt="images/fl_pinkbumps"></td><td width="25%"><a href="#fl_005fpinkbumps">fl_pinkbumps</a></td><td width="9%"><img src="images/fl_plank.png" alt="images/fl_plank"></td><td width="25%"><a href="#fl_005fplank">fl_plank</a></td></tr>

14993

<tr><td width="8%"><img src="images/fl_platinum.png" alt="images/fl_platinum"></td><td width="25%"><a href="#fl_005fplatinum">fl_platinum</a></td><td width="8%"><img src="images/fl_red.png" alt="images/fl_red"></td><td width="25%"><a href="#fl_005fred">fl_red</a></td><td width="9%"><img src="images/fl_redslab.png" alt="images/fl_redslab"></td><td width="25%"><a href="#fl_005fredslab">fl_redslab</a></td></tr>

14994

<tr><td width="8%"><img src="images/fl_rock.png" alt="images/fl_rock"></td><td width="25%"><a href="#fl_005frock">fl_rock</a></td><td width="8%"><img src="images/fl_rough.png" alt="images/fl_rough"></td><td width="25%"><a href="#fl_005frough">fl_rough</a></td><td width="9%"><img src="images/fl_sahara.png" alt="images/fl_sahara"></td><td width="25%"><a href="#fl_005fsahara">fl_sahara</a></td></tr>

14995

<tr><td width="8%"><img src="images/fl_samba.png" alt="images/fl_samba"></td><td width="25%"><a href="#fl_005fsamba">fl_samba</a></td><td width="8%"><img src="images/fl_sand.png" alt="images/fl_sand"></td><td width="25%"><a href="#fl_005fsand">fl_sand</a></td><td width="9%"><img src="images/fl_scales_brick.png" alt="images/fl_scales_brick"></td><td width="25%"><a href="#fl_005fscales">fl_scales</a>_brick</td></tr>

14996

<tr><td width="8%"><img src="images/fl_scales_bridge_bw_closed.png" alt="images/fl_scales_bridge_bw_closed"></td><td width="25%"><a href="#fl_005fscales">fl_scales</a>_bridgewood</td><td width="8%"><img src="images/fl_scales_concrete.png" alt="images/fl_scales_concrete"></td><td width="25%"><a href="#fl_005fscales">fl_scales</a>_concrete</td><td width="9%"><img src="images/fl_scales_darkgray.png" alt="images/fl_scales_darkgray"></td><td width="25%"><a href="#fl_005fscales">fl_scales</a>_darkgray</td></tr>

14997

<tr><td width="8%"><img src="images/fl_scales_gray.png" alt="images/fl_scales_gray"></td><td width="25%"><a href="#fl_005fscales">fl_scales</a>_gray</td><td width="8%"><img src="images/fl_scales_platinum.png" alt="images/fl_scales_platinum"></td><td width="25%"><a href="#fl_005fscales">fl_scales</a>_platinum</td><td width="9%"><img src="images/fl_slope_f.png" alt="images/fl_slope_f"></td><td width="25%"><a href="#fl_005fslope">fl_slope</a></td></tr>

14998

<tr><td width="8%"><img src="images/fl_slope.png" alt="images/fl_slope"></td><td width="25%"><a href="#fl_005fslope">fl_slope</a>_ps</td><td width="8%"><img src="images/fl_slope_c.png" alt="images/fl_slope_c"></td><td width="25%"><a href="#fl_005fslope">fl_slope</a>_ise</td><td width="9%"><img src="images/fl_slope_b.png" alt="images/fl_slope_b"></td><td width="25%"><a href="#fl_005fslope">fl_slope</a>_ose</td></tr>

14999

<tr><td width="8%"><img src="images/fl_space.png" alt="images/fl_space"></td><td width="25%"><a href="#fl_005fspace">fl_space</a></td><td width="8%"><img src="images/fl_stone.png" alt="images/fl_stone"></td><td width="25%"><a href="#fl_005fstone">fl_stone</a></td><td width="9%"><img src="images/fl_swamp.png" alt="images/fl_swamp"></td><td width="25%"><a href="#fl_005fswamp">fl_swamp</a></td></tr>

15000

<tr><td width="8%"><img src="images/fl_thief.png" alt="images/fl_thief"></td><td width="25%"><a href="#fl_005fthief">fl_thief</a></td><td width="8%"><img src="images/fl_thief_capture.png" alt="images/fl_thief_capture"></td><td width="25%"><a href="#fl_005fthief">fl_thief</a></td><td width="9%"><img src="images/fl_thief_drunken.png" alt="images/fl_thief_drunken"></td><td width="25%"><a href="#fl_005fthief">fl_thief</a></td></tr>

15001

<tr><td width="8%"><img src="images/fl_tigris.png" alt="images/fl_tigris"></td><td width="25%"><a href="#fl_005ftigris">fl_tigris</a></td><td width="8%"><img src="images/fl_water.png" alt="images/fl_water"></td><td width="25%"><a href="#fl_005fwater">fl_water</a></td><td width="9%"><img src="images/fl_white.png" alt="images/fl_white"></td><td width="25%"><a href="#fl_005fwhite">fl_white</a></td></tr>

15002

<tr><td width="8%"><img src="images/fl_wood.png" alt="images/fl_wood"></td><td width="25%"><a href="#fl_005fwood">fl_wood</a></td><td width="8%"><img src="images/fl_woven.png" alt="images/fl_woven"></td><td width="25%"><a href="#fl_005fwoven">fl_woven</a></td><td width="9%"><img src="images/fl_yinyang_yang.png" alt="images/fl_yinyang_yang"></td><td width="25%"><a href="#fl_005fyinyang">fl_yinyang</a>_yang</td></tr>

15003

<tr><td width="8%"><img src="images/fl_yinyang_yin.png" alt="images/fl_yinyang_yin"></td><td width="25%"><a href="#fl_005fyinyang">fl_yinyang</a>_yin</td></tr>

15004

</table>

15005

15006

15007

15008

15009

15010

15011

15012

15013

15014

15015

15016

15017

15018

15019

15020

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

15021

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

15022

15023

</tr></table>

15024

15025

<h2 class="section">7.2 Floor Attributes</h2>

15026

15027

15028

<tr><td align="left" valign="top"><a href="#adhesion-_0028floor_0029">7.2.1 adhesion (floor)</a></td><td>  </td><td align="left" valign="top"> Effectiveness of mousemotion

15029

</td></tr>

15030

<tr><td align="left" valign="top"><a href="#burnable">7.2.2 burnable</a></td><td>  </td><td align="left" valign="top"> -

15031

</td></tr>

15032

<tr><td align="left" valign="top"><a href="#eternal">7.2.3 eternal</a></td><td>  </td><td align="left" valign="top"> -

15033

</td></tr>

15034

<tr><td align="left" valign="top"><a href="#faces-_0028floor_0029">7.2.4 faces (floor)</a></td><td>  </td><td align="left" valign="top"> Framing Configuration

15035

</td></tr>

15036

<tr><td align="left" valign="top"><a href="#fastfire">7.2.5 fastfire</a></td><td>  </td><td align="left" valign="top"> -

15037

</td></tr>

15038

<tr><td align="left" valign="top"><a href="#floodable">7.2.6 floodable</a></td><td>  </td><td align="left" valign="top"> Flood Affinity

15039

</td></tr>

15040

<tr><td align="left" valign="top"><a href="#force_005fx">7.2.7 force_x</a></td><td>  </td><td align="left" valign="top"> Constant Force

15041

</td></tr>

15042

<tr><td align="left" valign="top"><a href="#force_005fy">7.2.8 force_y</a></td><td>  </td><td align="left" valign="top"> Constant Force

15043

</td></tr>

15044

<tr><td align="left" valign="top"><a href="#fragility-_0028floor_0029">7.2.9 fragility (floor)</a></td><td>  </td><td align="left" valign="top"> Crack

15045

</td></tr>

15046

<tr><td align="left" valign="top"><a href="#freeze_005fcheck-_0028floor_0029">7.2.10 freeze_check (floor)</a></td><td>  </td><td align="left" valign="top"> Freeze Checking

15047

</td></tr>

15048

<tr><td align="left" valign="top"><a href="#friction-_0028floor_0029">7.2.11 friction (floor)</a></td><td>  </td><td align="left" valign="top"> Decelerating friction force factor

15049

</td></tr>

15050

<tr><td align="left" valign="top"><a href="#ignitable">7.2.12 ignitable</a></td><td>  </td><td align="left" valign="top"> -

15051

</td></tr>

15052

<tr><td align="left" valign="top"><a href="#indestructible">7.2.13 indestructible</a></td><td>  </td><td align="left" valign="top"> System Flag for destruction resistance

15053

</td></tr>

15054

<tr><td align="left" valign="top"><a href="#initfire">7.2.14 initfire</a></td><td>  </td><td align="left" valign="top"> -

15055

</td></tr>

15056

<tr><td align="left" valign="top"><a href="#noash">7.2.15 noash</a></td><td>  </td><td align="left" valign="top"> -

15057

</td></tr>

15058

<tr><td align="left" valign="top"><a href="#push_005fdirections">7.2.16 push_directions</a></td><td>  </td><td align="left" valign="top"> Puzzle Shuffle Hint

15059

</td></tr>

15060

<tr><td align="left" valign="top"><a href="#secure">7.2.17 secure</a></td><td>  </td><td align="left" valign="top"> -

15061

</td></tr>

15062

<tr><td align="left" valign="top"><a href="#texture">7.2.18 texture</a></td><td>  </td><td align="left" valign="top"> Graphical Image Texture

15063

</td></tr>

15064

</table>

15065

15066

15067

15068

15069

15070

15071

15072

15073

15074

15075

15076

15077

15078

15079

15080

15081

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

15082

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

15083

15084

</tr></table>

15085

15086

<h3 class="subsection">7.2.1 adhesion (floor)</h3>

15087

15088

The responsiveness of an actor on mouse movements. It is a scalar factor to

15089

the accelerating force applied to an actor. Note that the actor itself

15090

has another scalar <a href="#adhesion-_0028actor_0029">adhesion (actor)</a> factor. The adhesion may take negative

15091

values, too. Such values correspond to inverse forces.

15092

15093

15094

<dt> Type:   number</dt>

15095

<dt> Values:   float number</dt>

15096

<dt> Default:   <code>0.0</code></dt>

15097

<dt> Access:   read/write</dt>

15098

</dl>

15099

15100

15101

15102

15103

15104

15105

15106

15107

15108

15109

15110

15111

15112

15113

15114

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

15115

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

15116

15117

</tr></table>

15118

15119

<h3 class="subsection">7.2.2 burnable</h3>

15120

15121

Determines whether the floor starts to burn when a fire is nearby and the item

15122

on the floor allows it to burn. See section <a href="#Fire-Spreading">Fire Spreading</a> for details.

15123

15124

15125

<dt> Type:   boolean</dt>

15126

<dt> Values:   <code>false</code>, <code>true</code></dt>

15127

<dt> Default:   <code>false</code></dt>

15128

<dt> Access:   read/write</dt>

15129

</dl>

15130

15131

15132

15133

15134

15135

15136

15137

15138

15139

15140

15141

15142

15143

15144

15145

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

15146

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

15147

15148

</tr></table>

15149

15150

<h3 class="subsection">7.2.3 eternal</h3>

15151

15152

Determines whether a fire keeps on burning unlimited, until an external cause

15153

stops it. See section <a href="#Fire-Spreading">Fire Spreading</a> for details.

15154

15155

15156

<dt> Type:   boolean</dt>

15157

<dt> Values:   <code>false</code>, <code>true</code></dt>

15158

<dt> Default:   <code>false</code></dt>

15159

<dt> Access:   read/write</dt>

15160

</dl>

15161

15162

15163

15164

15165

15166

15167

15168

15169

15170

15171

15172

15173

15174

15175

15176

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

15177

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

15178

15179

</tr></table>

15180

15181

<h3 class="subsection">7.2.4 faces (floor)</h3>

15182

15183

Describes if a floor is framed.

15184

15185

Currently a floor is either not framed at all or framed on all sides. The frame

15186

attribute can not be directly accessed and modified on most floors. Append the

15187

string <code>"_framed"</code> to a given floor name to yield the all side framed

15188

variant.

15189

15190

15191

<dt> Type:   string or nil</dt>

15192

<dt> Values:   <code>nil</code>, <code>"nesw"</code></dt>

15193

<dt> Default:   <code>nil</code></dt>

15194

<dt> Access:   none - with a few exceptions</dt>

15195

</dl>

15196

15197

15198

15199

15200

15201

15202

15203

15204

15205

15206

15207

15208

15209

15210

15211

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

15212

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

15213

15214

</tr></table>

15215

15216

<h3 class="subsection">7.2.5 fastfire</h3>

15217

15218

When set to <code>true</code>, fire will spread faster than usual, with the same

15219

speed as if <a href="#it_005fburnable">it_burnable</a>[_oil] would be on it. See section <a href="#Flood-Spreading">Flood Spreading</a> for

15220

details.

15221

15222

15223

<dt> Type:   boolean</dt>

15224

<dt> Values:   <code>false</code>, <code>true</code></dt>

15225

<dt> Default:   <code>false</code></dt>

15226

<dt> Access:   read/write</dt>

15227

</dl>

15228

15229

15230

15231

15232

15233

15234

15235

15236

15237

15238

15239

15240

15241

15242

15243

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

15244

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

15245

15246

</tr></table>

15247

15248

<h3 class="subsection">7.2.6 floodable</h3>

15249

15250

Determines whether a floor can be flooded by <a href="#fl_005fwater">fl_water</a> from a neighboring

15251

floor. See section <a href="#Flood-Spreading">Flood Spreading</a> for details.

15252

15253

15254

<dt> Type:   boolean</dt>

15255

<dt> Values:   <code>false</code>, <code>true</code></dt>

15256

<dt> Default:   <code>false</code></dt>

15257

<dt> Access:   read/write</dt>

15258

</dl>

15259

15260

15261

15262

15263

15264

15265

15266

15267

15268

15269

15270

15271

15272

15273

15274

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

15275

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

15276

15277

</tr></table>

15278

15279

<h3 class="subsection">7.2.7 force_x</h3>

15280

15281

A constant floor specific force into east direction applied additionally to all

15282

other forces to all actors on the floor.

15283

15284

15285

<dt> Type:   number</dt>

15286

<dt> Values:   float number</dt>

15287

<dt> Default:   <code>0.0</code></dt>

15288

<dt> Access:   read/write</dt>

15289

</dl>

15290

15291

15292

15293

15294

15295

15296

15297

15298

15299

15300

15301

15302

15303

15304

15305

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

15306

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

15307

15308

</tr></table>

15309

15310

<h3 class="subsection">7.2.8 force_y</h3>

15311

15312

A constant floor specific force into south direction applied additionally to all

15313

other forces to all actors on the floor.

15314

15315

15316

<dt> Type:   number</dt>

15317

<dt> Values:   float number</dt>

15318

<dt> Default:   <code>0.0</code></dt>

15319

<dt> Access:   read/write</dt>

15320

</dl>

15321

15322

15323

15324

15325

15326

15327

15328

15329

15330

15331

15332

15333

15334

15335

15336

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

15337

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

15338

15339

</tr></table>

15340

15341

<h3 class="subsection">7.2.9 fragility (floor)</h3>

15342

15343

A value denoting the probability that a brittle floor plate, that is a floor

15344

with an <a href="#it_005fcrack">it_crack</a> on top, continues to disintegrate on events like an actor

15345

entering, passing a neighboring <a href="#it_005fcrack">it_crack</a>, nearby explosions or fire

15346

heating. A value of <code>1.0</code> ensures that the crack continues to disintegrate

15347

on these events, a value of <code>0.0</code> prohibits visible cracks to get larger.

15348

This value is defaulted by <a href="#Fragility">Fragility</a> and superseded by <a href="#it_005fcrack">it_crack</a>

15349

specific values.

15350

15351

15352

<dt> Type:   number</dt>

15353

<dt> Values:   float numbers between <code>0.0</code> and <code>1.0</code></dt>

15354

<dt> Default:   <code>1.0</code></dt>

15355

<dt> Access:   read/write</dt>

15356

</dl>

15357

15358

15359

15360

15361

15362

15363

15364

15365

15366

15367

15368

15369

15370

15371

15372

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

15373

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

15374

15375

</tr></table>

15376

15377

<h3 class="subsection">7.2.10 freeze_check (floor)</h3>

15378

15379

If <code>true</code>, allows for <a href="#Freeze-Checking">Freeze Checking</a> on this floor tile. Note that

15380

Freeze Checking only works with those (movable) stones that have additionally set

15381

<code>freeze_check = true</code> on their own, see <a href="#freeze_005fcheck-_0028stone_0029">freeze_check (stone)</a>.

15382

15383

15384

<dt> Type:   boolean</dt>

15385

<dt> Values:   <code>false</code>, <code>true</code></dt>

15386

<dt> Default:   <code>false</code></dt>

15387

<dt> Access:   read/write</dt>

15388

</dl>

15389

15390

15391

15392

15393

15394

15395

15396

15397

15398

15399

15400

15401

15402

15403

15404

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

15405

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

15406

15407

</tr></table>

15408

15409

<h3 class="subsection">7.2.11 friction (floor)</h3>

15410

15411

see section <a href="#friction">friction</a>.

15412

15413

15414

<dt> Type:   number</dt>

15415

<dt> Values:   float number</dt>

15416

<dt> Default:   <code>0.0</code></dt>

15417

<dt> Access:   read/write</dt>

15418

</dl>

15419

15420

15421

15422

15423

15424

15425

15426

15427

15428

15429

15430

15431

15432

15433

15434

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

15435

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

15436

15437

</tr></table>

15438

15439

<h3 class="subsection">7.2.12 ignitable</h3>

15440

15441

When <code>true</code>, and the item on the floor allows it to burn, it will start

15442

burning on nearby explosions. See section <a href="#Fire-Spreading">Fire Spreading</a> for details.

15443

15444

15445

<dt> Type:   boolean</dt>

15446

<dt> Values:   <code>false</code>, <code>true</code></dt>

15447

<dt> Default:   <code>false</code></dt>

15448

<dt> Access:   read/write</dt>

15449

</dl>

15450

15451

15452

15453

15454

15455

15456

15457

15458

15459

15460

15461

15462

15463

15464

15465

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

15466

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

15467

15468

</tr></table>

15469

15470

<h3 class="subsection">7.2.13 indestructible</h3>

15471

15472

Most floors can dissolve to <a href="#fl_005fabyss">fl_abyss</a> or <a href="#fl_005fwater">fl_water</a> on destruction

15473

by explosions, fire, <a href="#ot_005fcannonball">ot_cannonball</a> hits, <a href="#it_005fcrack">it_crack</a>, <a href="#it_005ftrap">it_trap</a>,

15474

etc. But a few like <a href="#fl_005fabyss">fl_abyss</a>, <a href="#fl_005fwater">fl_water</a> and <a href="#fl_005fswamp">fl_swamp</a> are

15475

indestructible by all these events.

15476

15477

15478

<dt> Type:   boolean</dt>

15479

<dt> Values:   <code>false</code>, <code>true</code></dt>

15480

<dt> Default:   <code>false</code></dt>

15481

<dt> Access:   none</dt>

15482

</dl>

15483

15484

15485

15486

15487

15488

15489

15490

15491

15492

15493

15494

15495

15496

15497

15498

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

15499

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

15500

15501

</tr></table>

15502

15503

<h3 class="subsection">7.2.14 initfire</h3>

15504

15505

When set to <code>true</code>, the floor will start to burn after level

15506

initialization. See section <a href="#Fire-Spreading">Fire Spreading</a> for details.

15507

15508

15509

<dt> Type:   boolean</dt>

15510

<dt> Values:   <code>false</code>, <code>true</code></dt>

15511

<dt> Default:   <code>false</code></dt>

15512

<dt> Access:   read/write</dt>

15513

</dl>

15514

15515

15516

15517

15518

15519

15520

15521

15522

15523

15524

15525

15526

15527

15528

15529

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

15530

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

15531

15532

</tr></table>

15533

15534

<h3 class="subsection">7.2.15 noash</h3>

15535

15536

Determines whether <a href="#it_005fburnable">it_burnable</a>_ash is put onto the floor after a fire

15537

stops. Ash stops a floor from re-igniting, so <code>noash = true</code> will allow a

15538

floor to start burning a second time, unless the item on it or its

15539

<code>burnable</code>-attribute deny fire. See section <a href="#Fire-Spreading">Fire Spreading</a> for details.

15540

15541

<a href="#fl_005fabyss">fl_abyss</a> is the only floor with <code>noash = true</code> by default, because

15542

ash falls into the abyss. Note however, that <a href="#fl_005fabyss">fl_abyss</a> isn’t burnable by

15543

default.

15544

15545

15546

<dt> Type:   boolean</dt>

15547

<dt> Values:   <code>false</code>, <code>true</code></dt>

15548

<dt> Default:   <code>false</code></dt>

15549

<dt> Access:   read/write</dt>

15550

</dl>

15551

15552

15553

15554

15555

15556

15557

15558

15559

15560

15561

15562

15563

15564

15565

15566

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

15567

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

15568

15569

</tr></table>

15570

15571

<h3 class="subsection">7.2.16 push_directions</h3>

15572

15573

A hint for the resolver <a href="#res_002epuzzle">res.puzzle</a> for shuffling of a puzzle. A floor

15574

marked with this attribute guarantees that an adjacent puzzle row or column

15575

can be push rotated into the listed directions by the user.

15576

15577

15578

<dt> Type:   string or nil</dt>

15579

<dt> Values:   <code>nil</code>, <code>"nesw"</code></dt>

15580

<dt> Default:   <code>nil</code></dt>

15581

<dt> Access:   read/write</dt>

15582

</dl>

15583

15584

15585

15586

15587

15588

15589

15590

15591

15592

15593

15594

15595

15596

15597

15598

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

15599

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

15600

15601

</tr></table>

15602

15603

<h3 class="subsection">7.2.17 secure</h3>

15604

15605

Ensures that a nearby fire eventually ignites this floor. See section <a href="#Fire-Spreading">Fire Spreading</a>

15606

for details.

15607

15608

15609

<dt> Type:   boolean</dt>

15610

<dt> Values:   <code>false</code>, <code>true</code></dt>

15611

<dt> Default:   <code>false</code></dt>

15612

<dt> Access:   read/write</dt>

15613

</dl>

15614

15615

15616

15617

15618

15619

15620

15621

15622

15623

15624

15625

15626

15627

15628

15629

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

15630

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

15631

15632

</tr></table>

15633

15634

<h3 class="subsection">7.2.18 texture</h3>

15635

15636

Many floors do provide several textures - graphical image variations that are

15637

without any influence on the physical engine. Most floors do select a random

15638

texture in their default variant. This generates areas without unintended

15639

optical effects. But on some floors you can select the textures by means

15640

of variant kind names to create your own graphical floor layout.

15641

15642

15643

<dt> Type:   integer number or string</dt>

15644

<dt> Values:   integer number or string</dt>

15645

<dt> Default:   <code>1</code></dt>

15646

<dt> Access:   currently none - just by variants kind string on some floors</dt>

15647

</dl>

15648

15649

15650

15651

15652

15653

15654

15655

15656

15657

15658

15659

15660

15661

15662

15663

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

15664

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

15665

15666

</tr></table>

15667

15668

<h2 class="section">7.3 Standard Floors</h2>

15669

15670

15671

<tr><td align="left" valign="top"><a href="#fl_005fadhesionless">7.3.1 fl_adhesionless</a></td><td>  </td><td align="left" valign="top"> Floor without adhesion but friction

15672

</td></tr>

15673

<tr><td align="left" valign="top"><a href="#fl_005faquamarine">7.3.2 fl_aquamarine</a></td><td>  </td><td align="left" valign="top"> Aquamarine floor with low friction

15674

</td></tr>

15675

<tr><td align="left" valign="top"><a href="#fl_005fbast">7.3.3 fl_bast</a></td><td>  </td><td align="left" valign="top"> Brown woven bast with black background

15676

</td></tr>

15677

<tr><td align="left" valign="top"><a href="#fl_005fbluegray">7.3.4 fl_bluegray</a></td><td>  </td><td align="left" valign="top"> Light blue gray floor

15678

</td></tr>

15679

<tr><td align="left" valign="top"><a href="#fl_005fbluegreen">7.3.5 fl_bluegreen</a></td><td>  </td><td align="left" valign="top"> Dark blue green floor

15680

</td></tr>

15681

<tr><td align="left" valign="top"><a href="#fl_005fblueslab">7.3.6 fl_blueslab</a></td><td>  </td><td align="left" valign="top"> Dark blue marbled slab

15682

</td></tr>

15683

<tr><td align="left" valign="top"><a href="#fl_005fbrick">7.3.7 fl_brick</a></td><td>  </td><td align="left" valign="top"> Floor composed of small red bricks

15684

</td></tr>

15685

<tr><td align="left" valign="top"><a href="#fl_005fbright">7.3.8 fl_bright</a></td><td>  </td><td align="left" valign="top"> Nearly white floor

15686

</td></tr>

15687

<tr><td align="left" valign="top"><a href="#fl_005fconcrete">7.3.9 fl_concrete</a></td><td>  </td><td align="left" valign="top"> Granular gray concrete

15688

</td></tr>

15689

<tr><td align="left" valign="top"><a href="#fl_005fdark">7.3.10 fl_dark</a></td><td>  </td><td align="left" valign="top"> Nearly black floor

15690

</td></tr>

15691

<tr><td align="left" valign="top"><a href="#fl_005fdarkgray">7.3.11 fl_darkgray</a></td><td>  </td><td align="left" valign="top"> Cold gray floor

15692

</td></tr>

15693

<tr><td align="left" valign="top"><a href="#fl_005fdunes">7.3.12 fl_dunes</a></td><td>  </td><td align="left" valign="top"> Brown granular dunes

15694

</td></tr>

15695

<tr><td align="left" valign="top"><a href="#fl_005fgravel">7.3.13 fl_gravel</a></td><td>  </td><td align="left" valign="top"> Dark gray, granular floor

15696

</td></tr>

15697

<tr><td align="left" valign="top"><a href="#fl_005fgray">7.3.14 fl_gray</a></td><td>  </td><td align="left" valign="top"> Gray with some brown spots

15698

</td></tr>

15699

<tr><td align="left" valign="top"><a href="#fl_005fhimalaya">7.3.15 fl_himalaya</a></td><td>  </td><td align="left" valign="top"> Blue purple marbled floor

15700

</td></tr>

15701

<tr><td align="left" valign="top"><a href="#fl_005fivory">7.3.16 fl_ivory</a></td><td>  </td><td align="left" valign="top"> Warm pearl white floor

15702

</td></tr>

15703

<tr><td align="left" valign="top"><a href="#fl_005flawn">7.3.17 fl_lawn</a></td><td>  </td><td align="left" valign="top"> Grass in several textures

15704

</td></tr>

15705

<tr><td align="left" valign="top"><a href="#fl_005fmarble">7.3.18 fl_marble</a></td><td>  </td><td align="left" valign="top"> Light red brown marbled floor

15706

</td></tr>

15707

<tr><td align="left" valign="top"><a href="#fl_005fmetal">7.3.19 fl_metal</a></td><td>  </td><td align="left" valign="top"> Metal floor in several textures

15708

</td></tr>

15709

<tr><td align="left" valign="top"><a href="#fl_005fmortar">7.3.20 fl_mortar</a></td><td>  </td><td align="left" valign="top"> Rough white floor with gray wrinkles

15710

</td></tr>

15711

<tr><td align="left" valign="top"><a href="#fl_005fpinkbumps">7.3.21 fl_pinkbumps</a></td><td>  </td><td align="left" valign="top"> Pink floor with white bumps

15712

</td></tr>

15713

<tr><td align="left" valign="top"><a href="#fl_005fplank">7.3.22 fl_plank</a></td><td>  </td><td align="left" valign="top"> Small diagonal planks

15714

</td></tr>

15715

<tr><td align="left" valign="top"><a href="#fl_005fplatinum">7.3.23 fl_platinum</a></td><td>  </td><td align="left" valign="top"> Warm light gray floor

15716

</td></tr>

15717

<tr><td align="left" valign="top"><a href="#fl_005fred">7.3.24 fl_red</a></td><td>  </td><td align="left" valign="top"> Warm red floor with low friction

15718

</td></tr>

15719

<tr><td align="left" valign="top"><a href="#fl_005fredslab">7.3.25 fl_redslab</a></td><td>  </td><td align="left" valign="top"> Dark red marbled slab

15720

</td></tr>

15721

<tr><td align="left" valign="top"><a href="#fl_005frough">7.3.26 fl_rough</a></td><td>  </td><td align="left" valign="top"> Rough warm white floor

15722

</td></tr>

15723

<tr><td align="left" valign="top"><a href="#fl_005fsahara">7.3.27 fl_sahara</a></td><td>  </td><td align="left" valign="top"> Bright yellow sandstone floor

15724

</td></tr>

15725

<tr><td align="left" valign="top"><a href="#fl_005fsamba">7.3.28 fl_samba</a></td><td>  </td><td align="left" valign="top"> Grey bleached wooden floor

15726

</td></tr>

15727

<tr><td align="left" valign="top"><a href="#fl_005fsand">7.3.29 fl_sand</a></td><td>  </td><td align="left" valign="top"> Granular orange gray sand floor

15728

</td></tr>

15729

<tr><td align="left" valign="top"><a href="#fl_005fspace">7.3.30 fl_space</a></td><td>  </td><td align="left" valign="top"> Black space with a few sparkling stars

15730

</td></tr>

15731

<tr><td align="left" valign="top"><a href="#fl_005fstone">7.3.31 fl_stone</a></td><td>  </td><td align="left" valign="top"> Granular brown gray floor

15732

</td></tr>

15733

<tr><td align="left" valign="top"><a href="#fl_005ftigris">7.3.32 fl_tigris</a></td><td>  </td><td align="left" valign="top"> Red sandstone floor

15734

</td></tr>

15735

<tr><td align="left" valign="top"><a href="#fl_005fwhite">7.3.33 fl_white</a></td><td>  </td><td align="left" valign="top"> Pure white floor

15736

</td></tr>

15737

<tr><td align="left" valign="top"><a href="#fl_005fwoven">7.3.34 fl_woven</a></td><td>  </td><td align="left" valign="top"> White black woven floor

15738

</td></tr>

15739

</table>

15740

15741

15742

15743

15744

15745

15746

15747

15748

15749

15750

15751

15752

15753

15754

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

15755

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

15756

15757

</tr></table>

15758

15759

<h3 class="subsection">7.3.1 fl_adhesionless</h3>

15760

15761

15762

Orange velvet that offers no adhesion but causes friction.

15763

15764

15765

<dt> Attributes:</dt>

15766

15767

<dt> adhesion,   values: number;   default: 0.0   See section <a href="#adhesion">adhesion</a></dt>

15768

<dt> friction,   values: number;   default: 2.5   See section <a href="#friction">friction</a></dt>

15769

<dt> burnable,   values: boolean;   default: true   See section <a href="#burnable">burnable</a></dt>

15770

</dl>

15771

15772

</dd>

15773

<dt> Variants:</dt>

15774

15775

<dt> <img src="images/fl_adhesionless.png" alt="images/fl_adhesionless"> fl_adhesionless

15776

</dt>

15777

</dl>

15778

</dd>

15779

</dl>

15780

15781

15782

15783

15784

15785

15786

15787

15788

15789

15790

15791

15792

15793

15794

15795

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

15796

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

15797

15798

</tr></table>

15799

15800

<h3 class="subsection">7.3.2 fl_aquamarine</h3>

15801

15802

15803

Aquamarine floor with low friction.

15804

15805

15806

<dt> Attributes:</dt>

15807

15808

<dt> adhesion,   values: number;   default: 1.0   See section <a href="#adhesion">adhesion</a></dt>

15809

<dt> friction,   values: number;   default: 0.4   See section <a href="#friction">friction</a></dt>

15810

<dt> burnable,   values: boolean;   default: true   See section <a href="#burnable">burnable</a></dt>

15811

</dl>

15812

15813

</dd>

15814

<dt> Variants:</dt>

15815

15816

<dt> <img src="images/fl_aquamarine.png" alt="images/fl_aquamarine"> fl_aquamarine

15817

</dt>

15818

<dt> <img src="images/fl_aquamarine_framed.png" alt="images/fl_aquamarine_framed"> fl_aquamarine_framed

15819

</dt>

15820

</dl>

15821

</dd>

15822

</dl>

15823

15824

15825

15826

15827

15828

15829

15830

15831

15832

15833

15834

15835

15836

15837

15838

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

15839

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

15840

15841

</tr></table>

15842

15843

15844

15845

15846

Brown woven bast with black background.

15847

15848

When burnt, <code>fl_bast</code> will become <a href="#fl_005fabyss">fl_abyss</a>.

15849

15850

15851

<dt> Attributes:</dt>

15852

15853

<dt> adhesion,   values: number;   default: 2.5   See section <a href="#adhesion">adhesion</a></dt>

15854

<dt> friction,   values: number;   default: 1.5   See section <a href="#friction">friction</a></dt>

15855

<dt> burnable,   values: boolean;   default: true   See section <a href="#burnable">burnable</a></dt>

15856

</dl>

15857

15858

</dd>

15859

<dt> Variants:</dt>

15860

15861

<dt> <img src="images/fl_bast.png" alt="images/fl_bast"> fl_bast

15862

</dt>

15863

<dt> <img src="images/fl_bast_framed.png" alt="images/fl_bast_framed"> fl_bast_framed

15864

</dt>

15865

</dl>

15866

</dd>

15867

</dl>

15868

15869

15870

15871

15872

15873

15874

15875

15876

15877

15878

15879

15880

15881

15882

15883

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

15884

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

15885

15886

</tr></table>

15887

15888

<h3 class="subsection">7.3.4 fl_bluegray</h3>

15889

15890

15891

Light blue gray floor, visually indistinguishable from <a href="#fl_005fthief">fl_thief</a>.

15892

15893

15894

<dt> Attributes:</dt>

15895

15896

<dt> adhesion,   values: number;   default: 1.5   See section <a href="#adhesion">adhesion</a></dt>

15897

<dt> friction,   values: number;   default: 4.5   See section <a href="#friction">friction</a></dt>

15898

<dt> burnable,   values: boolean;   default: true   See section <a href="#burnable">burnable</a></dt>

15899

</dl>

15900

15901

</dd>

15902

<dt> Variants:</dt>

15903

15904

<dt> <img src="images/fl_bluegray.png" alt="images/fl_bluegray"> fl_bluegray

15905

</dt>

15906

<dt> <img src="images/fl_bluegray_framed.png" alt="images/fl_bluegray_framed"> fl_bluegray_framed

15907

</dt>

15908

</dl>

15909

</dd>

15910

</dl>

15911

15912

15913

15914

15915

15916

15917

15918

15919

15920

15921

15922

15923

15924

15925

15926

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

15927

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

15928

15929

</tr></table>

15930

15931

<h3 class="subsection">7.3.5 fl_bluegreen</h3>

15932

15933

15934

Dark blue green floor.

15935

15936

15937

<dt> Attributes:</dt>

15938

15939

<dt> adhesion,   values: number;   default: 2.0   See section <a href="#adhesion">adhesion</a></dt>

15940

<dt> friction,   values: number;   default: 6.0   See section <a href="#friction">friction</a></dt>

15941

<dt> burnable,   values: boolean;   default: true   See section <a href="#burnable">burnable</a></dt>

15942

</dl>

15943

15944

</dd>

15945

<dt> Variants:</dt>

15946

15947

<dt> <img src="images/fl_bluegreen.png" alt="images/fl_bluegreen"> fl_bluegreen

15948

</dt>

15949

<dt> <img src="images/fl_bluegreen_framed.png" alt="images/fl_bluegreen_framed"> fl_bluegreen_framed

15950

</dt>

15951

</dl>

15952

</dd>

15953

</dl>

15954

15955

15956

15957

15958

15959

15960

15961

15962

15963

15964

15965

15966

15967

15968

15969

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

15970

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

15971

15972

</tr></table>

15973

15974

<h3 class="subsection">7.3.6 fl_blueslab</h3>

15975

15976

15977

Dark blue slab like floor, that is marbled with black. A matching floor is

15978

<a href="#fl_005fredslab">fl_redslab</a>.

15979

15980

15981

<dt> Attributes:</dt>

15982

15983

<dt> adhesion,   values: number;   default: 2.0   See section <a href="#adhesion">adhesion</a></dt>

15984

<dt> friction,   values: number;   default: 7.0   See section <a href="#friction">friction</a></dt>

15985

<dt> burnable,   values: boolean;   default: true   See section <a href="#burnable">burnable</a></dt>

15986

</dl>

15987

15988

</dd>

15989

<dt> Variants:</dt>

15990

15991

<dt> <img src="images/fl_blueslab.png" alt="images/fl_blueslab"> fl_blueslab

15992

</dt>

15993

<dt> <img src="images/fl_blueslab_framed.png" alt="images/fl_blueslab_framed"> fl_blueslab_framed

15994

</dt>

15995

</dl>

15996

</dd>

15997

</dl>

15998

15999

16000

16001

16002

16003

16004

16005

16006

16007

16008

16009

16010

16011

16012

16013

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

16014

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

16015

16016

</tr></table>

16017

16018

<h3 class="subsection">7.3.7 fl_brick</h3>

16019

16020

16021

Floor composed of small red bricks.

16022

16023

16024

<dt> Attributes:</dt>

16025

16026

<dt> adhesion,   values: number;   default: 2.0   See section <a href="#adhesion">adhesion</a></dt>

16027

<dt> friction,   values: number;   default: 3.5   See section <a href="#friction">friction</a></dt>

16028

<dt> burnable,   values: boolean;   default: false   See section <a href="#burnable">burnable</a></dt>

16029

</dl>

16030

16031

</dd>

16032

<dt> Variants:</dt>

16033

16034

<dt> <img src="images/fl_brick.png" alt="images/fl_brick"> fl_brick

16035

</dt>

16036

<dt> <img src="images/fl_brick_framed.png" alt="images/fl_brick_framed"> fl_brick_framed

16037

</dt>

16038

</dl>

16039

</dd>

16040

</dl>

16041

16042

16043

16044

16045

16046

16047

16048

16049

16050

16051

16052

16053

16054

16055

16056

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

16057

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

16058

16059

</tr></table>

16060

16061

<h3 class="subsection">7.3.8 fl_bright</h3>

16062

16063

16064

Nearly white floor without any yinyang related features. A matching floor is

16065

<a href="#fl_005fdark">fl_dark</a>.

16066

16067

16068

<dt> Attributes:</dt>

16069

16070

<dt> adhesion,   values: number;   default: 1.5   See section <a href="#adhesion">adhesion</a></dt>

16071

<dt> friction,   values: number;   default: 3.0   See section <a href="#friction">friction</a></dt>

16072

<dt> burnable,   values: boolean;   default: false   See section <a href="#burnable">burnable</a></dt>

16073

</dl>

16074

16075

</dd>

16076

<dt> Variants:</dt>

16077

16078

<dt> <img src="images/fl_bright.png" alt="images/fl_bright"> fl_bright

16079

</dt>

16080

<dt> <img src="images/fl_bright_framed.png" alt="images/fl_bright_framed"> fl_bright_framed

16081

</dt>

16082

</dl>

16083

</dd>

16084

</dl>

16085

16086

16087

16088

16089

16090

16091

16092

16093

16094

16095

16096

16097

16098

16099

16100

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

16101

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

16102

16103

</tr></table>

16104

16105

<h3 class="subsection">7.3.9 fl_concrete</h3>

16106

16107

16108

Granular gray concrete.

16109

16110

16111

<dt> Attributes:</dt>

16112

16113

<dt> adhesion,   values: number;   default: 1.3   See section <a href="#adhesion">adhesion</a></dt>

16114

<dt> friction,   values: number;   default: 4.5   See section <a href="#friction">friction</a></dt>

16115

<dt> burnable,   values: boolean;   default: false   See section <a href="#burnable">burnable</a></dt>

16116

</dl>

16117

16118

</dd>

16119

<dt> Variants:</dt>

16120

16121

<dt> <img src="images/fl_concrete.png" alt="images/fl_concrete"> fl_concrete

16122

</dt>

16123

<dt> <img src="images/fl_concrete_framed.png" alt="images/fl_concrete_framed"> fl_concrete_framed

16124

</dt>

16125

</dl>

16126

</dd>

16127

</dl>

16128

16129

16130

16131

16132

16133

16134

16135

16136

16137

16138

16139

16140

16141

16142

16143

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

16144

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

16145

16146

</tr></table>

16147

16148

16149

16150

16151

Nearly black floor without any yinyang related features. A matching floor is

16152

<a href="#fl_005fbright">fl_bright</a>.

16153

16154

16155

<dt> Attributes:</dt>

16156

16157

<dt> adhesion,   values: number;   default: 1.5   See section <a href="#adhesion">adhesion</a></dt>

16158

<dt> friction,   values: number;   default: 3.0   See section <a href="#friction">friction</a></dt>

16159

<dt> burnable,   values: boolean;   default: false   See section <a href="#burnable">burnable</a></dt>

16160

</dl>

16161

16162

</dd>

16163

<dt> Variants:</dt>

16164

16165

<dt> <img src="images/fl_dark.png" alt="images/fl_dark"> fl_dark

16166

</dt>

16167

<dt> <img src="images/fl_dark_framed.png" alt="images/fl_dark_framed"> fl_dark_framed

16168

</dt>

16169

</dl>

16170

</dd>

16171

</dl>

16172

16173

16174

16175

16176

16177

16178

16179

16180

16181

16182

16183

16184

16185

16186

16187

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

16188

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

16189

16190

</tr></table>

16191

16192

<h3 class="subsection">7.3.11 fl_darkgray</h3>

16193

16194

16195

A medium to dark gray floor.

16196

16197

16198

<dt> Attributes:</dt>

16199

16200

<dt> adhesion,   values: number;   default: 1.6   See section <a href="#adhesion">adhesion</a></dt>

16201

<dt> friction,   values: number;   default: 3.0   See section <a href="#friction">friction</a></dt>

16202

<dt> burnable,   values: boolean;   default: false   See section <a href="#burnable">burnable</a></dt>

16203

</dl>

16204

16205

</dd>

16206

<dt> Variants:</dt>

16207

16208

<dt> <img src="images/fl_darkgray.png" alt="images/fl_darkgray"> fl_darkgray

16209

</dt>

16210

<dt> <img src="images/fl_darkgray_framed.png" alt="images/fl_darkgray_framed"> fl_darkgray_framed

16211

</dt>

16212

</dl>

16213

</dd>

16214

</dl>

16215

16216

16217

16218

16219

16220

16221

16222

16223

16224

16225

16226

16227

16228

16229

16230

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

16231

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

16232

16233

</tr></table>

16234

16235

<h3 class="subsection">7.3.12 fl_dunes</h3>

16236

16237

16238

Brown granular dunes.

16239

16240

16241

<dt> Attributes:</dt>

16242

16243

<dt> adhesion,   values: number;   default: 1.0   See section <a href="#adhesion">adhesion</a></dt>

16244

<dt> friction,   values: number;   default: 1.3   See section <a href="#friction">friction</a></dt>

16245

<dt> burnable,   values: boolean;   default: false   See section <a href="#burnable">burnable</a></dt>

16246

</dl>

16247

16248

</dd>

16249

<dt> Variants:</dt>

16250

16251

<dt> <img src="images/fl_dunes.png" alt="images/fl_dunes"> fl_dunes

16252

</dt>

16253

<dt> <img src="images/fl_dunes_framed.png" alt="images/fl_dunes_framed"> fl_dunes_framed

16254

</dt>

16255

</dl>

16256

</dd>

16257

</dl>

16258

16259

16260

16261

16262

16263

16264

16265

16266

16267

16268

16269

16270

16271

16272

16273

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

16274

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

16275

16276

</tr></table>

16277

16278

<h3 class="subsection">7.3.13 fl_gravel</h3>

16279

16280

16281

Dark gray, granular floor.

16282

16283

16284

<dt> Attributes:</dt>

16285

16286

<dt> adhesion,   values: number;   default: 1.5   See section <a href="#adhesion">adhesion</a></dt>

16287

<dt> friction,   values: number;   default: 3.2   See section <a href="#friction">friction</a></dt>

16288

<dt> burnable,   values: boolean;   default: false   See section <a href="#burnable">burnable</a></dt>

16289

</dl>

16290

16291

</dd>

16292

<dt> Variants:</dt>

16293

16294

<dt> <img src="images/fl_gravel.png" alt="images/fl_gravel"> fl_gravel

16295

</dt>

16296

<dt> <img src="images/fl_gravel_framed.png" alt="images/fl_gravel_framed"> fl_gravel_framed

16297

</dt>

16298

</dl>

16299

</dd>

16300

</dl>

16301

16302

16303

16304

16305

16306

16307

16308

16309

16310

16311

16312

16313

16314

16315

16316

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

16317

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

16318

16319

</tr></table>

16320

16321

16322

16323

16324

Gray with some brown spots.

16325

16326

16327

<dt> Attributes:</dt>

16328

16329

<dt> adhesion,   values: number;   default: 3.0   See section <a href="#adhesion">adhesion</a></dt>

16330

<dt> friction,   values: number;   default: 5.0   See section <a href="#friction">friction</a></dt>

16331

<dt> burnable,   values: boolean;   default: false   See section <a href="#burnable">burnable</a></dt>

16332

</dl>

16333

16334

</dd>

16335

<dt> Variants:</dt>

16336

16337

<dt> <img src="images/fl_gray.png" alt="images/fl_gray"> fl_gray

16338

</dt>

16339

<dt> <img src="images/fl_gray_framed.png" alt="images/fl_gray_framed"> fl_gray_framed

16340

</dt>

16341

</dl>

16342

</dd>

16343

</dl>

16344

16345

16346

16347

16348

16349

16350

16351

16352

16353

16354

16355

16356

16357

16358

16359

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

16360

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

16361

16362

</tr></table>

16363

16364

<h3 class="subsection">7.3.15 fl_himalaya</h3>

16365

16366

16367

Blue purple marbled floor.

16368

16369

16370

<dt> Attributes:</dt>

16371

16372

<dt> adhesion,   values: number;   default: 2.0   See section <a href="#adhesion">adhesion</a></dt>

16373

<dt> friction,   values: number;   default: 5.0   See section <a href="#friction">friction</a></dt>

16374

<dt> burnable,   values: boolean;   default: false   See section <a href="#burnable">burnable</a></dt>

16375

</dl>

16376

16377

</dd>

16378

<dt> Variants:</dt>

16379

16380

<dt> <img src="images/fl_himalaya.png" alt="images/fl_himalaya"> fl_himalaya

16381

</dt>

16382

<dt> <img src="images/fl_himalaya_framed.png" alt="images/fl_himalaya_framed"> fl_himalaya_framed

16383

</dt>

16384

</dl>

16385

</dd>

16386

</dl>

16387

16388

16389

16390

16391

16392

16393

16394

16395

16396

16397

16398

16399

16400

16401

16402

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

16403

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

16404

16405

</tr></table>

16406

16407

<h3 class="subsection">7.3.16 fl_ivory</h3>

16408

16409

16410

Warm ivory or pearl white floor.

16411

16412

16413

<dt> Attributes:</dt>

16414

16415

<dt> adhesion,   values: number;   default: 1.6   See section <a href="#adhesion">adhesion</a></dt>

16416

<dt> friction,   values: number;   default: 2.2   See section <a href="#friction">friction</a></dt>

16417

<dt> burnable,   values: boolean;   default: true   See section <a href="#burnable">burnable</a></dt>

16418

</dl>

16419

16420

</dd>

16421

<dt> Variants:</dt>

16422

16423

<dt> <img src="images/fl_ivory.png" alt="images/fl_ivory"> fl_ivory

16424

</dt>

16425

<dt> <img src="images/fl_ivory_framed.png" alt="images/fl_ivory_framed"> fl_ivory_framed

16426

</dt>

16427

</dl>

16428

</dd>

16429

</dl>

16430

16431

16432

16433

16434

16435

16436

16437

16438

16439

16440

16441

16442

16443

16444

16445

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

16446

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

16447

16448

</tr></table>

16449

16450

16451

16452

16453

Grass floor. Light and dark grass and different textures of both exist.

16454

16455

When burnt, <code>fl_lawn</code> becomes <a href="#fl_005fdunes">fl_dunes</a>.

16456

16457

16458

<dt> Attributes:</dt>

16459

16460

<dt> adhesion,   values: number;   default: 1.5   See section <a href="#adhesion">adhesion</a></dt>

16461

<dt> friction,   values: number;   default: 4.0   See section <a href="#friction">friction</a></dt>

16462

<dt> texture,   values: "a","b","c1","c2","c3","c4","d1","d2","d3","d4","e1","e2","e3","e4" ;   default: "a";   access: <code>none</code>   See section <a href="#texture">texture</a></dt>

16463

<dt> burnable,   values: boolean;   default: true   See section <a href="#burnable">burnable</a></dt>

16464

</dl>

16465

16466

</dd>

16467

<dt> Variants:</dt>

16468

16469

<tr><td width="8%"><img src="images/fl_lawn.png" alt="images/fl_lawn"></td><td width="42%">fl_lawn_a: texture = ‘<samp>"a"</samp>’</td><td width="8%"><img src="images/fl_lawn_c.png" alt="images/fl_lawn_c"></td><td width="42%">fl_lawn_b: texture = ‘<samp>"b"</samp>’</td></tr>

16470

<tr><td width="8%"><img src="images/fl_lawn_e.png" alt="images/fl_lawn_e"></td><td width="42%">fl_lawn_c1: texture = ‘<samp>"c1"</samp>’</td><td width="8%"><img src="images/fl_lawn_f.png" alt="images/fl_lawn_f"></td><td width="42%">fl_lawn_c3: texture = ‘<samp>"c3"</samp>’</td></tr>

16471

<tr><td width="8%"><img src="images/fl_lawn_e2.png" alt="images/fl_lawn_e2"></td><td width="42%">fl_lawn_c2: texture = ‘<samp>"c2"</samp>’</td><td width="8%"><img src="images/fl_lawn_f2.png" alt="images/fl_lawn_f2"></td><td width="42%">fl_lawn_c4: texture = ‘<samp>"c4"</samp>’</td></tr>

16472

<tr><td width="8%"><img src="images/fl_lawn_g.png" alt="images/fl_lawn_g"></td><td width="42%">fl_lawn_d1: texture = ‘<samp>"d1"</samp>’</td><td width="8%"><img src="images/fl_lawn_h.png" alt="images/fl_lawn_h"></td><td width="42%">fl_lawn_d3: texture = ‘<samp>"d3"</samp>’</td></tr>

16473

<tr><td width="8%"><img src="images/fl_lawn_g2.png" alt="images/fl_lawn_g2"></td><td width="42%">fl_lawn_d2: texture = ‘<samp>"d2"</samp>’</td><td width="8%"><img src="images/fl_lawn_h2.png" alt="images/fl_lawn_h2"></td><td width="42%">fl_lawn_d4: texture = ‘<samp>"d4"</samp>’</td></tr>

16474

<tr><td width="8%"><img src="images/fl_lawn_i.png" alt="images/fl_lawn_i"></td><td width="42%">fl_lawn_e1: texture = ‘<samp>"e1"</samp>’</td><td width="8%"><img src="images/fl_lawn_j.png" alt="images/fl_lawn_j"></td><td width="42%">fl_lawn_e3: texture = ‘<samp>"e3"</samp>’</td></tr>

16475

<tr><td width="8%"><img src="images/fl_lawn_i2.png" alt="images/fl_lawn_i2"></td><td width="42%">fl_lawn_e2: texture = ‘<samp>"e2"</samp>’</td><td width="8%"><img src="images/fl_lawn_j2.png" alt="images/fl_lawn_j2"></td><td width="42%">fl_lawn_e4: texture = ‘<samp>"e4"</samp>’</td></tr>

16476

<tr><td width="8%"><img src="images/fl_lawn.png" alt="images/fl_lawn"></td><td width="42%">fl_lawn: texture = ‘<samp>"a"</samp>’</td></tr>

16477

</table>

16478

</dd>

16479

</dl>

16480

16481

16482

16483

16484

16485

16486

16487

16488

16489

16490

16491

16492

16493

16494

16495

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

16496

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

16497

16498

</tr></table>

16499

16500

<h3 class="subsection">7.3.18 fl_marble</h3>

16501

16502

16503

Light red brown marbled floor.

16504

16505

16506

<dt> Attributes:</dt>

16507

16508

<dt> adhesion,   values: number;   default: 2.0   See section <a href="#adhesion">adhesion</a></dt>

16509

<dt> friction,   values: number;   default: 6.4   See section <a href="#friction">friction</a></dt>

16510

<dt> burnable,   values: boolean;   default: true   See section <a href="#burnable">burnable</a></dt>

16511

</dl>

16512

16513

</dd>

16514

<dt> Variants:</dt>

16515

16516

<dt> <img src="images/fl_marble.png" alt="images/fl_marble"> fl_marble

16517

</dt>

16518

<dt> <img src="images/fl_marble_framed.png" alt="images/fl_marble_framed"> fl_marble_framed

16519

</dt>

16520

</dl>

16521

</dd>

16522

</dl>

16523

16524

16525

16526

16527

16528

16529

16530

16531

16532

16533

16534

16535

16536

16537

16538

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

16539

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

16540

16541

</tr></table>

16542

16543

<h3 class="subsection">7.3.19 fl_metal</h3>

16544

16545

16546

Grey metal floor with rivets. Several different textures exists with horizontal

16547

or vertical aligned joists and various rivets.

16548

16549

16550

<dt> Attributes:</dt>

16551

16552

<dt> adhesion,   values: number;   default: 2.0   See section <a href="#adhesion">adhesion</a></dt>

16553

<dt> friction,   values: number;   default: 3.0   See section <a href="#friction">friction</a></dt>

16554

<dt> texture,   values: integer number, 1 <= n <= 7 ;   default: random;   access: <code>none</code>   See section <a href="#texture">texture</a></dt>

16555

<dt> burnable,   values: boolean;   default: false   See section <a href="#burnable">burnable</a></dt>

16556

</dl>

16557

16558

</dd>

16559

<dt> Variants:</dt>

16560

16561

<tr><td width="8%"><img src="images/fl_metal.png" alt="images/fl_metal"></td><td width="42%">fl_metal: texture = ‘<samp>random</samp>’</td><td width="8%"><img src="images/fl_metal_framed.png" alt="images/fl_metal_framed"></td><td width="42%">fl_metal_framed: texture = ‘<samp>random</samp>’</td></tr>

16562

<tr><td width="8%"><img src="images/fl_metal.png" alt="images/fl_metal"></td><td width="42%">fl_metal_1: texture = <code>1</code></td><td width="8%"><img src="images/fl_metal_framed.png" alt="images/fl_metal_framed"></td><td width="42%">fl_metal_1_framed: texture = <code>1</code></td></tr>

16563

<tr><td width="8%"><img src="images/fl_metal_2.png" alt="images/fl_metal_2"></td><td width="42%">fl_metal_2: texture = <code>2</code></td><td width="8%"><img src="images/construction.png" alt="images/construction"></td><td width="42%">fl_metal_2_framed: texture = <code>2</code></td></tr>

16564

<tr><td width="8%"><img src="images/fl_metal_3.png" alt="images/fl_metal_3"></td><td width="42%">fl_metal_3: texture = <code>3</code></td><td width="8%"><img src="images/construction.png" alt="images/construction"></td><td width="42%">fl_metal_3_framed: texture = <code>3</code></td></tr>

16565

<tr><td width="8%"><img src="images/fl_metal_4.png" alt="images/fl_metal_4"></td><td width="42%">fl_metal_4: texture = <code>4</code></td><td width="8%"><img src="images/construction.png" alt="images/construction"></td><td width="42%">fl_metal_4_framed: texture = <code>4</code></td></tr>

16566

<tr><td width="8%"><img src="images/fl_metal_5.png" alt="images/fl_metal_5"></td><td width="42%">fl_metal_5: texture = <code>5</code></td><td width="8%"><img src="images/construction.png" alt="images/construction"></td><td width="42%">fl_metal_5_framed: texture = <code>5</code></td></tr>

16567

<tr><td width="8%"><img src="images/fl_metal_6.png" alt="images/fl_metal_6"></td><td width="42%">fl_metal_6: texture = <code>6</code></td><td width="8%"><img src="images/construction.png" alt="images/construction"></td><td width="42%">fl_metal_6_framed: texture = <code>6</code></td></tr>

16568

<tr><td width="8%"><img src="images/fl_metal_7.png" alt="images/fl_metal_7"></td><td width="42%">fl_metal_7: texture = <code>7</code></td><td width="8%"><img src="images/construction.png" alt="images/construction"></td><td width="42%">fl_metal_7_framed: texture = <code>7</code></td></tr>

16569

</table>

16570

</dd>

16571

</dl>

16572

16573

16574

16575

16576

16577

16578

16579

16580

16581

16582

16583

16584

16585

16586

16587

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

16588

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

16589

16590

</tr></table>

16591

16592

<h3 class="subsection">7.3.20 fl_mortar</h3>

16593

16594

16595

Very rough brilliant white floor.

16596

16597

16598

<dt> Attributes:</dt>

16599

16600

<dt> adhesion,   values: number;   default: 1.8   See section <a href="#adhesion">adhesion</a></dt>

16601

<dt> friction,   values: number;   default: 7.2   See section <a href="#friction">friction</a></dt>

16602

<dt> burnable,   values: boolean;   default: false   See section <a href="#burnable">burnable</a></dt>

16603

</dl>

16604

16605

</dd>

16606

<dt> Variants:</dt>

16607

16608

<dt> <img src="images/fl_mortar.png" alt="images/fl_mortar"> fl_mortar

16609

</dt>

16610

<dt> <img src="images/fl_mortar_framed.png" alt="images/fl_mortar_framed"> fl_mortar_framed

16611

</dt>

16612

</dl>

16613

</dd>

16614

</dl>

16615

16616

16617

16618

16619

16620

16621

16622

16623

16624

16625

16626

16627

16628

16629

16630

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

16631

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

16632

16633

</tr></table>

16634

16635

<h3 class="subsection">7.3.21 fl_pinkbumps</h3>

16636

16637

16638

Pink floor with white bumps.

16639

16640

16641

<dt> Attributes:</dt>

16642

16643

<dt> adhesion,   values: number;   default: 1.2   See section <a href="#adhesion">adhesion</a></dt>

16644

<dt> friction,   values: number;   default: 5.0   See section <a href="#friction">friction</a></dt>

16645

<dt> burnable,   values: boolean;   default: false   See section <a href="#burnable">burnable</a></dt>

16646

</dl>

16647

16648

</dd>

16649

<dt> Variants:</dt>

16650

16651

<dt> <img src="images/fl_pinkbumps.png" alt="images/fl_pinkbumps"> fl_pinkbumps

16652

</dt>

16653

<dt> <img src="images/fl_pinkbumps_framed.png" alt="images/fl_pinkbumps_framed"> fl_pinkbumps_framed

16654

</dt>

16655

</dl>

16656

</dd>

16657

</dl>

16658

16659

16660

16661

16662

16663

16664

16665

16666

16667

16668

16669

16670

16671

16672

16673

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

16674

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

16675

16676

</tr></table>

16677

16678

<h3 class="subsection">7.3.22 fl_plank</h3>

16679

16680

16681

Floor build up by small diagonal orange brown planks.

16682

16683

When burnt, <code>fl_plank</code> becomes <a href="#fl_005fabyss">fl_abyss</a>.

16684

16685

16686

<dt> Attributes:</dt>

16687

16688

<dt> adhesion,   values: number;   default: 2.0   See section <a href="#adhesion">adhesion</a></dt>

16689

<dt> friction,   values: number;   default: 5.5   See section <a href="#friction">friction</a></dt>

16690

<dt> burnable,   values: boolean;   default: false   See section <a href="#burnable">burnable</a></dt>

16691

</dl>

16692

16693

</dd>

16694

<dt> Variants:</dt>

16695

16696

<dt> <img src="images/fl_plank.png" alt="images/fl_plank"> fl_plank

16697

</dt>

16698

<dt> <img src="images/fl_plank_framed.png" alt="images/fl_plank_framed"> fl_plank_framed

16699

</dt>

16700

</dl>

16701

</dd>

16702

</dl>

16703

16704

16705

16706

16707

16708

16709

16710

16711

16712

16713

16714

16715

16716

16717

16718

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

16719

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

16720

16721

</tr></table>

16722

16723

<h3 class="subsection">7.3.23 fl_platinum</h3>

16724

16725

16726

Warm light gray floor.

16727

16728

16729

<dt> Attributes:</dt>

16730

16731

<dt> adhesion,   values: number;   default: 1.6   See section <a href="#adhesion">adhesion</a></dt>

16732

<dt> friction,   values: number;   default: 3.0   See section <a href="#friction">friction</a></dt>

16733

<dt> burnable,   values: boolean;   default: true   See section <a href="#burnable">burnable</a></dt>

16734

</dl>

16735

16736

</dd>

16737

<dt> Variants:</dt>

16738

16739

<dt> <img src="images/fl_platinum.png" alt="images/fl_platinum"> fl_platinum

16740

</dt>

16741

<dt> <img src="images/fl_platinum_framed.png" alt="images/fl_platinum_framed"> fl_platinum_framed

16742

</dt>

16743

</dl>

16744

</dd>

16745

</dl>

16746

16747

16748

16749

16750

16751

16752

16753

16754

16755

16756

16757

16758

16759

16760

16761

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

16762

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

16763

16764

</tr></table>

16765

16766

16767

16768

16769

Warm red, very slippy floor.

16770

16771

16772

<dt> Attributes:</dt>

16773

16774

<dt> adhesion,   values: number;   default: 1.0   See section <a href="#adhesion">adhesion</a></dt>

16775

<dt> friction,   values: number;   default: 0.9   See section <a href="#friction">friction</a></dt>

16776

<dt> burnable,   values: boolean;   default: true   See section <a href="#burnable">burnable</a></dt>

16777

</dl>

16778

16779

</dd>

16780

<dt> Variants:</dt>

16781

16782

<dt> <img src="images/fl_red.png" alt="images/fl_red"> fl_red

16783

</dt>

16784

<dt> <img src="images/fl_red_framed.png" alt="images/fl_red_framed"> fl_red_framed

16785

</dt>

16786

</dl>

16787

</dd>

16788

</dl>

16789

16790

16791

16792

16793

16794

16795

16796

16797

16798

16799

16800

16801

16802

16803

16804

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

16805

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

16806

16807

</tr></table>

16808

16809

<h3 class="subsection">7.3.25 fl_redslab</h3>

16810

16811

16812

Dark red slab floor, that is marbled with black. A matching floor is

16813

<a href="#fl_005fblueslab">fl_blueslab</a>.

16814

16815

16816

<dt> Attributes:</dt>

16817

16818

<dt> adhesion,   values: number;   default: 2.0   See section <a href="#adhesion">adhesion</a></dt>

16819

<dt> friction,   values: number;   default: 7.0   See section <a href="#friction">friction</a></dt>

16820

<dt> burnable,   values: boolean;   default: true   See section <a href="#burnable">burnable</a></dt>

16821

</dl>

16822

16823

</dd>

16824

<dt> Variants:</dt>

16825

16826

<dt> <img src="images/fl_redslab.png" alt="images/fl_redslab"> fl_redslab

16827

</dt>

16828

<dt> <img src="images/fl_redslab_framed.png" alt="images/fl_redslab_framed"> fl_redslab_framed

16829

</dt>

16830

</dl>

16831

</dd>

16832

</dl>

16833

16834

16835

16836

16837

16838

16839

16840

16841

16842

16843

16844

16845

16846

16847

16848

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

16849

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

16850

16851

</tr></table>

16852

16853

<h3 class="subsection">7.3.26 fl_rough</h3>

16854

16855

16856

Rough warm white floor.

16857

16858

16859

<dt> Attributes:</dt>

16860

16861

<dt> adhesion,   values: number;   default: 2.0   See section <a href="#adhesion">adhesion</a></dt>

16862

<dt> friction,   values: number;   default: 7.0   See section <a href="#friction">friction</a></dt>

16863

<dt> burnable,   values: boolean;   default: true   See section <a href="#burnable">burnable</a></dt>

16864

</dl>

16865

16866

</dd>

16867

<dt> Variants:</dt>

16868

16869

<dt> <img src="images/fl_rough.png" alt="images/fl_rough"> fl_rough

16870

</dt>

16871

<dt> <img src="images/fl_rough_framed.png" alt="images/fl_rough_framed"> fl_rough_framed

16872

</dt>

16873

</dl>

16874

</dd>

16875

</dl>

16876

16877

16878

16879

16880

16881

16882

16883

16884

16885

16886

16887

16888

16889

16890

16891

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

16892

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

16893

16894

</tr></table>

16895

16896

<h3 class="subsection">7.3.27 fl_sahara</h3>

16897

16898

16899

Bright yellow sandstone floor.

16900

16901

16902

<dt> Attributes:</dt>

16903

16904

<dt> adhesion,   values: number;   default: 2.0   See section <a href="#adhesion">adhesion</a></dt>

16905

<dt> friction,   values: number;   default: 6.4   See section <a href="#friction">friction</a></dt>

16906

<dt> burnable,   values: boolean;   default: false   See section <a href="#burnable">burnable</a></dt>

16907

</dl>

16908

16909

</dd>

16910

<dt> Variants:</dt>

16911

16912

<dt> <img src="images/fl_sahara.png" alt="images/fl_sahara"> fl_sahara

16913

</dt>

16914

<dt> <img src="images/fl_sahara_framed.png" alt="images/fl_sahara_framed"> fl_sahara_framed

16915

</dt>

16916

</dl>

16917

</dd>

16918

</dl>

16919

16920

16921

16922

16923

16924

16925

16926

16927

16928

16929

16930

16931

16932

16933

16934

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

16935

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

16936

16937

</tr></table>

16938

16939

<h3 class="subsection">7.3.28 fl_samba</h3>

16940

16941

16942

Gray bleached wooden floor. Textures with horizontal and vertical aligned plank

16943

exist.

16944

16945

When burnt, <code>fl_samba</code> becomes <a href="#fl_005fabyss">fl_abyss</a>.

16946

16947

16948

<dt> Attributes:</dt>

16949

16950

<dt> adhesion,   values: number;   default: 2.0   See section <a href="#adhesion">adhesion</a></dt>

16951

<dt> friction,   values: number;   default: 6.0   See section <a href="#friction">friction</a></dt>

16952

<dt> texture,   values: "h", "v" ;   default: random;   access: <code>none</code>   See section <a href="#texture">texture</a></dt>

16953

<dt> burnable,   values: boolean;   default: true   See section <a href="#burnable">burnable</a></dt>

16954

</dl>

16955

16956

</dd>

16957

<dt> Variants:</dt>

16958

16959

<dt> <img src="images/fl_samba.png" alt="images/fl_samba"> fl_samba: texture = ‘<samp>random</samp>’

16960

</dt>

16961

<dt> <img src="images/fl_samba.png" alt="images/fl_samba"> fl_samba_h: texture = <code>"h"</code>

16962

</dt>

16963

<dt> <img src="images/fl_samba_2.png" alt="images/fl_samba_2"> fl_samba_v: texture = <code>"v"</code>

16964

</dt>

16965

<dt> <img src="images/fl_samba_framed.png" alt="images/fl_samba_framed"> fl_samba_framed: texture = ‘<samp>random</samp>’

16966

</dt>

16967

<dt> <img src="images/fl_samba_framed.png" alt="images/fl_samba_framed"> fl_samba_h_framed: texture = <code>"h"</code>

16968

</dt>

16969

<dt> <img src="images/construction.png" alt="images/construction"> fl_samba_v_framed: texture = <code>"v"</code>

16970

</dt>

16971

</dl>

16972

</dd>

16973

</dl>

16974

16975

16976

16977

16978

16979

16980

16981

16982

16983

16984

16985

16986

16987

16988

16989

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

16990

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

16991

16992

</tr></table>

16993

16994

16995

16996

16997

Granular orange gray sand floor.

16998

16999

17000

<dt> Attributes:</dt>

17001

17002

<dt> adhesion,   values: number;   default: 2.0   See section <a href="#adhesion">adhesion</a></dt>

17003

<dt> friction,   values: number;   default: 6.0   See section <a href="#friction">friction</a></dt>

17004

<dt> burnable,   values: boolean;   default: false   See section <a href="#burnable">burnable</a></dt>

17005

</dl>

17006

17007

</dd>

17008

<dt> Variants:</dt>

17009

17010

<dt> <img src="images/fl_sand.png" alt="images/fl_sand"> fl_sand

17011

</dt>

17012

<dt> <img src="images/fl_sand_framed.png" alt="images/fl_sand_framed"> fl_sand_framed

17013

</dt>

17014

</dl>

17015

</dd>

17016

</dl>

17017

17018

17019

17020

17021

17022

17023

17024

17025

17026

17027

17028

17029

17030

17031

17032

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

17033

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

17034

17035

</tr></table>

17036

17037

<h3 class="subsection">7.3.30 fl_space</h3>

17038

17039

17040

Black space with a few sparkling stars. This floor has neither a friction nor

17041

does it provide an adhesion. All actors do drift for infinity on this floor

17042

until they reach another floor.

17043

17044

17045

<dt> Attributes:</dt>

17046

17047

<dt> adhesion,   values: number;   default: 0.0   See section <a href="#adhesion">adhesion</a></dt>

17048

<dt> friction,   values: number;   default: 0.0   See section <a href="#friction">friction</a></dt>

17049

<dt> burnable,   values: boolean;   default: false   See section <a href="#burnable">burnable</a></dt>

17050

</dl>

17051

17052

</dd>

17053

<dt> Variants:</dt>

17054

17055

<dt> <img src="images/fl_space.png" alt="images/fl_space"> fl_space

17056

</dt>

17057

</dl>

17058

</dd>

17059

</dl>

17060

17061

17062

17063

17064

17065

17066

17067

17068

17069

17070

17071

17072

17073

17074

17075

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

17076

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

17077

17078

</tr></table>

17079

17080

<h3 class="subsection">7.3.31 fl_stone</h3>

17081

17082

17083

Granular brown gray floor.

17084

17085

17086

<dt> Attributes:</dt>

17087

17088

<dt> adhesion,   values: number;   default: 1.0   See section <a href="#adhesion">adhesion</a></dt>

17089

<dt> friction,   values: number;   default: 1.4   See section <a href="#friction">friction</a></dt>

17090

<dt> burnable,   values: boolean;   default: false   See section <a href="#burnable">burnable</a></dt>

17091

</dl>

17092

17093

</dd>

17094

<dt> Variants:</dt>

17095

17096

<dt> <img src="images/fl_stone.png" alt="images/fl_stone"> fl_stone

17097

</dt>

17098

<dt> <img src="images/fl_stone_framed.png" alt="images/fl_stone_framed"> fl_stone_framed

17099

</dt>

17100

</dl>

17101

</dd>

17102

</dl>

17103

17104

17105

17106

17107

17108

17109

17110

17111

17112

17113

17114

17115

17116

17117

17118

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

17119

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

17120

17121

</tr></table>

17122

17123

<h3 class="subsection">7.3.32 fl_tigris</h3>

17124

17125

17126

Red sandstone floor.

17127

17128

17129

<dt> Attributes:</dt>

17130

17131

<dt> adhesion,   values: number;   default: 2.0   See section <a href="#adhesion">adhesion</a></dt>

17132

<dt> friction,   values: number;   default: 6.0   See section <a href="#friction">friction</a></dt>

17133

<dt> burnable,   values: boolean;   default: true   See section <a href="#burnable">burnable</a></dt>

17134

</dl>

17135

17136

</dd>

17137

<dt> Variants:</dt>

17138

17139

<dt> <img src="images/fl_tigris.png" alt="images/fl_tigris"> fl_tigris

17140

</dt>

17141

<dt> <img src="images/fl_tigris_framed.png" alt="images/fl_tigris_framed"> fl_tigris_framed

17142

</dt>

17143

</dl>

17144

</dd>

17145

</dl>

17146

17147

17148

17149

17150

17151

17152

17153

17154

17155

17156

17157

17158

17159

17160

17161

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

17162

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

17163

17164

</tr></table>

17165

17166

<h3 class="subsection">7.3.33 fl_white</h3>

17167

17168

17169

Pure white floor without any yinyang related features.

17170

17171

17172

<dt> Attributes:</dt>

17173

17174

<dt> adhesion,   values: number;   default: 2.0   See section <a href="#adhesion">adhesion</a></dt>

17175

<dt> friction,   values: number;   default: 4.0   See section <a href="#friction">friction</a></dt>

17176

<dt> burnable,   values: boolean;   default: false   See section <a href="#burnable">burnable</a></dt>

17177

</dl>

17178

17179

</dd>

17180

<dt> Variants:</dt>

17181

17182

<dt> <img src="images/fl_white.png" alt="images/fl_white"> fl_white

17183

</dt>

17184

<dt> <img src="images/fl_white_framed.png" alt="images/fl_white_framed"> fl_white_framed

17185

</dt>

17186

</dl>

17187

</dd>

17188

</dl>

17189

17190

17191

17192

17193

17194

17195

17196

17197

17198

17199

17200

17201

17202

17203

17204

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

17205

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

17206

17207

</tr></table>

17208

17209

<h3 class="subsection">7.3.34 fl_woven</h3>

17210

17211

17212

Diagonal woven white floor with black shadows.

17213

17214

17215

<dt> Attributes:</dt>

17216

17217

<dt> adhesion,   values: number;   default: 3.0   See section <a href="#adhesion">adhesion</a></dt>

17218

<dt> friction,   values: number;   default: 6.5   See section <a href="#friction">friction</a></dt>

17219

<dt> burnable,   values: boolean;   default: true   See section <a href="#burnable">burnable</a></dt>

17220

</dl>

17221

17222

</dd>

17223

<dt> Variants:</dt>

17224

17225

<dt> <img src="images/fl_woven.png" alt="images/fl_woven"> fl_woven

17226

</dt>

17227

<dt> <img src="images/fl_woven_framed.png" alt="images/fl_woven_framed"> fl_woven_framed

17228

</dt>

17229

</dl>

17230

</dd>

17231

</dl>

17232

17233

17234

17235

17236

17237

17238

17239

17240

17241

17242

17243

17244

17245

17246

17247

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

17248

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

17249

17250

</tr></table>

17251

17252

<h2 class="section">7.4 Special Floors</h2>

17253

17254

17255

<tr><td align="left" valign="top"><a href="#fl_005fabyss">7.4.1 fl_abyss</a></td><td>  </td><td align="left" valign="top"> Deep black Chasm

17256

</td></tr>

17257

<tr><td align="left" valign="top"><a href="#fl_005fbridge">7.4.2 fl_bridge</a></td><td>  </td><td align="left" valign="top"> Abyss Bridge

17258

</td></tr>

17259

<tr><td align="left" valign="top"><a href="#fl_005ffake">7.4.3 fl_fake</a></td><td>  </td><td align="left" valign="top"> Fake mimicking other Floors

17260

</td></tr>

17261

<tr><td align="left" valign="top"><a href="#fl_005fhay">7.4.4 fl_hay</a></td><td>  </td><td align="left" valign="top"> Floodable Hay

17262

</td></tr>

17263

<tr><td align="left" valign="top"><a href="#fl_005fice">7.4.5 fl_ice</a></td><td>  </td><td align="left" valign="top"> Slippery frozen water

17264

</td></tr>

17265

<tr><td align="left" valign="top"><a href="#fl_005finverse">7.4.6 fl_inverse</a></td><td>  </td><td align="left" valign="top"> Accelerate into the inverse direction

17266

</td></tr>

17267

<tr><td align="left" valign="top"><a href="#fl_005frock">7.4.7 fl_rock</a></td><td>  </td><td align="left" valign="top"> Floodable Rock Floor

17268

</td></tr>

17269

<tr><td align="left" valign="top"><a href="#fl_005fscales">7.4.8 fl_scales</a></td><td>  </td><td align="left" valign="top"> Weight dependent Trigger

17270

</td></tr>

17271

<tr><td align="left" valign="top"><a href="#fl_005fslope">7.4.9 fl_slope</a></td><td>  </td><td align="left" valign="top"> Slopes in various shapes

17272

</td></tr>

17273

<tr><td align="left" valign="top"><a href="#fl_005fswamp">7.4.10 fl_swamp</a></td><td>  </td><td align="left" valign="top"> Sticky sinkable Floor

17274

</td></tr>

17275

<tr><td align="left" valign="top"><a href="#fl_005fthief">7.4.11 fl_thief</a></td><td>  </td><td align="left" valign="top"> Hidden Thief

17276

</td></tr>

17277

<tr><td align="left" valign="top"><a href="#fl_005fwater">7.4.12 fl_water</a></td><td>  </td><td align="left" valign="top"> Sinkable Water

17278

</td></tr>

17279

<tr><td align="left" valign="top"><a href="#fl_005fwood">7.4.13 fl_wood</a></td><td>  </td><td align="left" valign="top"> Floodable Wood Floor

17280

</td></tr>

17281

<tr><td align="left" valign="top"><a href="#fl_005fyinyang">7.4.14 fl_yinyang</a></td><td>  </td><td align="left" valign="top"> Player dependent Adhesion

17282

</td></tr>

17283

</table>

17284

17285

17286

17287

17288

17289

17290

17291

17292

17293

17294

17295

17296

17297

17298

17299

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

17300

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

17301

17302

</tr></table>

17303

17304

<h3 class="subsection">7.4.1 fl_abyss</h3>

17305

17306

17307

Pure black abyss into which all rolling balls do fall and shatter. An abyss

17308

chasm can be crossed by jumping. <a href="#Actors">Actors</a> protected by an activated

17309

<a href="#it_005fumbrella">it_umbrella</a> can pass and even move on an abyss as it provides useful

17310

‘<samp>adhesion</samp>’ and ‘<samp>friction</samp>’. Another comparable floor barrier is

17311

<a href="#fl_005fwater">fl_water</a>.

17312

17313

Many floors disintegrate on fire or on a dissolving <a href="#it_005fcrack">it_crack</a> into an

17314

abyss. The abyss itself is indestructible. It does neither burn nor crack.

17315

17316

Some stones fall into abyss, too. <a href="#st_005fbox">st_box</a> will build floors on which all

17317

actors can move and pass the former abyss filled grid.

17318

17319

By default, <code>fl_abyss</code> can’t burn. However, when it burns (e.g. by

17320

<a href="#it_005fburnable">it_burnable</a>_oil), it does not create <a href="#it_005fburnable">it_burnable</a>_ash in the end by

17321

default (i.e., <a href="#noash">noash</a> is true by default). In particular, when

17322

<code>burnable</code> is set to <code>true</code>, an abyss may reignite arbitrarily often.

17323

17324

17325

<dt> Attributes:</dt>

17326

17327

<dt> adhesion,   values: number;   default: 1.0   See section <a href="#adhesion">adhesion</a></dt>

17328

<dt> friction,   values: number;   default: 2.0   See section <a href="#friction">friction</a></dt>

17329

<dt> indestructible,   values: bool ;   default: true;   access: <code>none</code>   See section <a href="#indestructible">indestructible</a></dt>

17330

<dt> burnable,   values: boolean;   default: false   See section <a href="#burnable">burnable</a></dt>

17331

<dt> noash,   values: boolean;   default: true   See section <a href="#noash">noash</a></dt>

17332

</dl>

17333

17334

</dd>

17335

<dt> Variants:</dt>

17336

17337

<dt> <img src="images/fl_abyss.png" alt="images/fl_abyss"> fl_abyss

17338

</dt>

17339

</dl>

17340

</dd>

17341

</dl>

17342

17343

17344

17345

17346

17347

17348

17349

17350

17351

17352

17353

17354

17355

17356

17357

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

17358

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

17359

17360

</tr></table>

17361

17362

<h3 class="subsection">7.4.2 fl_bridge</h3>

17363

17364

17365

A bridge is a variable floor that can be passed when being <code>CLOSED</code> but

17366

being impassable for marbles like <a href="#fl_005fabyss">fl_abyss</a> when being opened. Floor

17367

bridges come in several flavors. They can be grey or wooden brown, they can

17368

pop up in the center or emerge from one side. The flavor string is a combination

17369

of a color character and an emerging direction character. Note that not all

17370

combinations do exist.

17371

17372

Bridges can be opened and closed via messages and state set operations like

17373

<a href="#st_005fdoor">st_door</a>.

17374

17375

But a unique feature of bridges is to close on a solid stone being pushed onto

17376

them. Thus stones do not fall into the visible abyss of an opened bridge, but

17377

can be pushed over them. But as soon as the stone leaves the bridge it opens

17378

again. Thus a user will notice the closing and opening bridge on stone pushes.

17379

17380

To be more precise after a stone leaving a bridge, it switches into the state

17381

that it would have had if the stone would never have been on top of it. That

17382

means that if a stone gets pushed onto an open bridge and the bridge receives

17383

a <code>"close"</code> or <code>"toggle"</code> message while the stone is being on top the

17384

bridge remains closed when the stone is pushed away.

17385

17386

A bridge being set adjusts its state according to the <a href="#Snapshot-Principle">Snapshot Principle</a>.

17387

It checks for solid stones being on top of it and auto closes accordingly.

17388

17389

Only the brown (wooden) bridges are burnable by default. Open bridges are never

17390

burnable, regardless of the <a href="#burnable">burnable</a>-attribute.

17391

17392

17393

<dt> Attributes:</dt>

17394

<dd>

17395

17396

<dt> state,   values: <code>CLOSED</code>, <code>OPEN</code>;   default: <code>OPEN</code>   See section <a href="#state">state</a></dt>

17397

<dd>The state as visible and responsible for the actor ability to pass.

17398

</dd>

17399

<dt> flavor,   values: <code>"gc"</code>, <code>"bw"</code>, <code>"bs"</code>, <code>"be"</code>, <code>"bn"</code>;   default: <code>"gc"</code></dt>

17400

<dd>The type of the bridge.

17401

</dd>

17402

<dt> adhesion,   values: number;   default: 1.0   See section <a href="#adhesion">adhesion</a></dt>

17403

<dt> friction,   values: number;   default: 5.0   See section <a href="#friction">friction</a></dt>

17404

<dt> burnable,   values: boolean;   default: depends on <code>flavor</code>   See section <a href="#burnable">burnable</a></dt>

17405

<dd>True if flavor is <code>"b*"</code>, false otherwise.

17406

</dd>

17407

</dl>

17408

17409

</dd>

17410

<dt> Messages:</dt>

17411

17412

<dt> open   See section <a href="#open">open</a></dt>

17413

<dd>Opens a closed bridge that is not covered by a solid stone. Otherwise the

17414

explicit open request will be registered and executed as soon as the stone

17415

is pushed away.

17416

</dd>

17417

<dt> close   See section <a href="#close">close</a></dt>

17418

<dd>Closes an open bridge. If the bridge is already closed by a covering solid

17419

stone, the request will be registered and the bridge will not open when the

17420

stone is pushed away.

17421

</dd>

17422

<dt> signal   See section <a href="#signal">signal</a></dt>

17423

<dd>A signal of value 1 sends an open message, a signal of value 0 sends a close

17424

message.

17425

</dd>

17426

<dt> toggle   See section <a href="#toggle">toggle</a></dt>

17427

<dd>A toggle causes a change of the state if no stone is on top, or the registered

17428

explicit state if a solid stone currently covers the bridge.

17429

</dd>

17430

</dl>

17431

17432

17433

</dd>

17434

<dt> Variants:</dt>

17435

17436

<dt> <img src="images/fl_bridge_gc_closed.png" alt="images/fl_bridge_gc_closed"> fl_bridge flavor = <code>"gc"</code>

17437

</dt>

17438

<dt> <img src="images/fl_bridge_gc_closed.png" alt="images/fl_bridge_gc_closed"> fl_bridge_gc flavor = <code>"gc"</code>

17439

</dt>

17440

<dt> <img src="images/fl_bridge_bw_closed.png" alt="images/fl_bridge_bw_closed"> fl_bridge_bw flavor = <code>"bw"</code>

17441

</dt>

17442

<dt> <img src="images/fl_bridge_bw_closed.png" alt="images/fl_bridge_bw_closed"> fl_bridge_bs flavor = <code>"bs"</code>

17443

</dt>

17444

<dt> <img src="images/fl_bridge_bw_closed.png" alt="images/fl_bridge_bw_closed"> fl_bridge_be flavor = <code>"be"</code>

17445

</dt>

17446

<dt> <img src="images/fl_bridge_bw_closed.png" alt="images/fl_bridge_bw_closed"> fl_bridge_bn flavor = <code>"bn"</code>

17447

</dt>

17448

</dl>

17449

17450

</dd>

17451

</dl>

17452

17453

17454

17455

17456

17457

17458

17459

17460

17461

17462

17463

17464

17465

17466

17467

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

17468

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

17469

17470

</tr></table>

17471

17472

17473

17474

17475

A floor that mimics other floors, but does not act like them.

17476

17477

In contrast to <a href="#fl_005fabyss">fl_abyss</a> the fake abyss is just a standard floor that lets

17478

pass any actor without any harm.

17479

17480

A fake trigger looks similar to an <a href="#it_005ftrigger">it_trigger</a> but is just a standard floor

17481

without any special features.

17482

17483

17484

<dt> Attributes:</dt>

17485

17486

<dt> adhesion,   values: number;   default: 2.0   See section <a href="#adhesion">adhesion</a></dt>

17487

<dt> friction,   values: number;   default: 3.0   See section <a href="#friction">friction</a></dt>

17488

<dt> flavor,   values: <code>"abyss"</code>, <code>"trigger"</code>;   default: <code>"abyss"</code>;   access: <code>none</code></dt>

17489

<dt> burnable,   values: boolean;   default: depends on <code>flavor</code>   See section <a href="#burnable">burnable</a></dt>

17490

<dd>True if flavor is <code>"trigger"</code>, false otherwise.

17491

</dd>

17492

</dl>

17493

17494

</dd>

17495

<dt> Variants:</dt>

17496

17497

<dt> <img src="images/fl_abyss.png" alt="images/fl_abyss"> fl_fake_abyss: flavor = <code>"abyss"</code>

17498

</dt>

17499

<dt> <img src="images/fl_fake_trigger.png" alt="images/fl_fake_trigger"> fl_fake_trigger: flavor = <code>"trigger"</code>

17500

</dt>

17501

</dl>

17502

</dd>

17503

</dl>

17504

17505

17506

17507

17508

17509

17510

17511

17512

17513

17514

17515

17516

17517

17518

17519

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

17520

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

17521

17522

</tr></table>

17523

17524

17525

17526

17527

A hay floor is in most aspects a standard floor, that exists in a framed

17528

variation, too.

17529

17530

The framed variant is the successor of a fallen <a href="#st_005fbox">st_box</a>_hay. It may be

17531

flooded by a <a href="#fl_005fwater">fl_water</a> stream without the attribute ‘<samp>floodable</samp>’ being

17532

set to ‘<samp>true</samp>’ as the flood passes below this floor. The framed wood

17533

acts like a bridge over a flood stream and the water will continue to spread to

17534

neighboring grids, while the framed wood is still passable for actors. In fact

17535

a framed wood can even operate as a flood source, but we do not recommend this

17536

usage. see section <a href="#Flood-Spreading">Flood Spreading</a>.

17537

17538

17539

<dt> Attributes:</dt>

17540

17541

<dt> state,   values: <code>IDLE</code>, <code>FLOODING</code>;   default: <code>IDLE</code>   See section <a href="#state">state</a></dt>

17542

<dt> interval   values: positive number;   default: <code>0.2</code></dt>

17543

<dd>Number of seconds .

17544

</dd>

17545

<dt> adhesion,   values: number;   default: 1.5   See section <a href="#adhesion">adhesion</a></dt>

17546

<dt> friction,   values: number;   default: 5.0   See section <a href="#friction">friction</a></dt>

17547

<dt> burnable,   values: boolean;   default: true   See section <a href="#burnable">burnable</a></dt>

17548

</dl>

17549

17550

</dd>

17551

<dt> Variants:</dt>

17552

17553

<dt> <img src="images/fl_hay.png" alt="images/fl_hay"> fl_hay

17554

</dt>

17555

<dt> <img src="images/fl_hay_framed.png" alt="images/fl_hay_framed"> fl_hay_framed: faces = <code>"nesw"</code>

17556

</dt>

17557

</dl>

17558

</dd>

17559

</dl>

17560

17561

17562

17563

17564

17565

17566

17567

17568

17569

17570

17571

17572

17573

17574

17575

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

17576

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

17577

17578

</tr></table>

17579

17580

17581

17582

17583

An ice floor is very slippery frozen water. The user can increase the effective

17584

friction by carrying an <a href="#it_005fpin">it_pin</a> in the players inventory.

17585

17586

Ice is a standard floor in most aspects. But an <a href="#it_005fdynamite">it_dynamite</a> will leave

17587

an <a href="#it_005fcrack">it_crack</a>_water instead of a meditation hollow, and nearby fire heat

17588

will melt the ice to <a href="#fl_005fwater">fl_water</a> (see <a href="#Heat_002dTransformation">Heat-Transformation</a>).

17589

17590

17591

<dt> Attributes:</dt>

17592

17593

<dt> adhesion,   values: number;   default: 0.1   See section <a href="#adhesion">adhesion</a></dt>

17594

<dt> friction,   values: number;   default: 0.1   See section <a href="#friction">friction</a></dt>

17595

<dt> burnable,   values: boolean;   default: false   See section <a href="#burnable">burnable</a></dt>

17596

</dl>

17597

17598

</dd>

17599

<dt> Variants:</dt>

17600

17601

<dt> <img src="images/fl_ice.png" alt="images/fl_ice"> fl_ice

17602

</dt>

17603

</dl>

17604

</dd>

17605

</dl>

17606

17607

17608

17609

17610

17611

17612

17613

17614

17615

17616

17617

17618

17619

17620

17621

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

17622

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

17623

17624

</tr></table>

17625

17626

<h3 class="subsection">7.4.6 fl_inverse</h3>

17627

17628

17629

Inverse floors accelerate all actors into the opposite direction of the applied

17630

mouse input force. In all other aspects they are just standard floors.

17631

17632

17633

<dt> Attributes:</dt>

17634

17635

<dt> adhesion,   values: number;   default: -2.0   See section <a href="#adhesion">adhesion</a></dt>

17636

<dt> friction,   values: number;   default: 3.0   See section <a href="#friction">friction</a></dt>

17637

<dt> flavor,   values: <code>"white"</code>, <code>"gray"</code>;   default: <code>"white"</code>;   access: <code>none</code></dt>

17638

<dt> burnable,   values: boolean;   default: false   See section <a href="#burnable">burnable</a></dt>

17639

</dl>

17640

17641

</dd>

17642

<dt> Variants:</dt>

17643

17644

<dt> <img src="images/fl_inverse_white.png" alt="images/fl_inverse_white"> fl_inverse: flavor = <code>"white"</code>

17645

</dt>

17646

<dt> <img src="images/fl_inverse_white.png" alt="images/fl_inverse_white"> fl_inverse_white: flavor = <code>"white"</code>

17647

</dt>

17648

<dt> <img src="images/fl_inverse_gray.png" alt="images/fl_inverse_gray"> fl_inverse_gray: flavor = <code>"gray"</code>

17649

</dt>

17650

</dl>

17651

</dd>

17652

</dl>

17653

17654

17655

17656

17657

17658

17659

17660

17661

17662

17663

17664

17665

17666

17667

17668

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

17669

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

17670

17671

</tr></table>

17672

17673

17674

17675

17676

A rock floor is in most aspects a standard floor, that exists in a framed

17677

variation, too.

17678

17679

The framed variant is the successor of a fallen <a href="#st_005fbox">st_box</a>_rock. It may be

17680

flooded by a <a href="#fl_005fwater">fl_water</a> stream without the attribute ‘<samp>floodable</samp>’ being

17681

set to ‘<samp>true</samp>’ as the flood passes below this floor. The framed wood

17682

acts like a bridge over a flood stream and the water will continue to spread to

17683

neighboring grids, while the framed wood is still passable for actors. In fact

17684

a framed wood can even operate as a flood source, but we do not recommend this

17685

usage. see section <a href="#Flood-Spreading">Flood Spreading</a>.

17686

17687

17688

<dt> Attributes:</dt>

17689

17690

<dt> state,   values: <code>IDLE</code>, <code>FLOODING</code>;   default: <code>IDLE</code>   See section <a href="#state">state</a></dt>

17691

<dt> interval   values: positive number;   default: <code>0.2</code></dt>

17692

<dd>Number of seconds .

17693

</dd>

17694

<dt> adhesion,   values: number;   default: 2.2   See section <a href="#adhesion">adhesion</a></dt>

17695

<dt> friction,   values: number;   default: 6.5   See section <a href="#friction">friction</a></dt>

17696

<dt> burnable,   values: boolean;   default: false   See section <a href="#burnable">burnable</a></dt>

17697

</dl>

17698

17699

</dd>

17700

<dt> Variants:</dt>

17701

17702

<dt> <img src="images/fl_rock.png" alt="images/fl_rock"> fl_rock

17703

</dt>

17704

<dt> <img src="images/fl_rock_framed.png" alt="images/fl_rock_framed"> fl_rock_framed: faces = <code>"nesw"</code>

17705

</dt>

17706

</dl>

17707

</dd>

17708

</dl>

17709

17710

17711

17712

17713

17714

17715

17716

17717

17718

17719

17720

17721

17722

17723

17724

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

17725

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

17726

17727

</tr></table>

17728

17729

<h3 class="subsection">7.4.8 fl_scales</h3>

17730

17731

17732

The scales floor is a trigger that reacts on the mass load of actors and items

17733

atop or any stones that may press it. It performs actions when it is initially

17734

pressed and again when it releases. A pressed trigger is in state ‘<samp>ON</samp>’ and

17735

will send an action value of ‘<samp>true</samp>’, a released trigger is in state

17736

‘<samp>OFF</samp>’ and will send an action value of ‘<samp>false</samp>’.

17737

17738

Only actors moving on the floor can press scales. An actor jumping over a

17739

scale will not press it. An actor jumping on a scale will release and press

17740

it again. But anyway the mass of all actors and items atop will be measured and

17741

compared to the given <code>min</code> attribute. The default triggering mass is 1.8.

17742

This mass is given by two <a href="#ac_005fmarble">ac_marble</a> or three <a href="#ac_005fpearl">ac_pearl</a>. Any item

17743

like <a href="#it_005fweight">it_weight</a> or weights in an <a href="#it_005fbag">it_bag</a> that are either dropped on

17744

top of scales or carried by any actor in the players inventory is added to the

17745

actors basic mass.

17746

17747

Just solid stones will press the scales when pushed onto it. Floating, hollow

17748

stones will generally not press the scales with the exception of the hollow,

17749

central puzzle stone (see section <a href="#st_005fpuzzle">st_puzzle</a>).

17750

17751

There is no way to set the state of a trigger manually. But the state can

17752

nevertheless be read. At initialization a scales floor that is pressed by

17753

objects will start in state ‘<samp>ON</samp>’ without sending actions due to the

17754

<a href="#Snapshot-Principle">Snapshot Principle</a>.

17755

17756

Scales trigger with a click sound.

17757

17758

Scales are given in several flavors. They are similar to the <a href="#it_005ftrigger">it_trigger</a>

17759

in respect to their features. Visually they look similar to frames, but are

17760

well distinguishable. It is deprecated to use invisible <a href="#it_005ftrigger">it_trigger</a> on

17761

a framed floor as a substitution for scales.

17762

17763

Alternative items that react just on actors are <a href="#it_005fsensor">it_sensor</a> and

17764

<a href="#it_005fcross">it_cross</a>.

17765

17766

17767

<dt> Attributes:</dt>

17768

17769

<dt> state,   values: <code>ON</code>, <code>OFF</code>;   default: <code>OFF</code>   See section <a href="#state">state</a></dt>

17770

<dd>The current switch state - ‘<samp>ON</samp>’ for pressed scales, ‘<samp>OFF</samp>’ for a

17771

released scales.

17772

</dd>

17773

<dt> flavor,   values: <code>"brick"</code>, <code>"bridgewood"</code>, <code>"concrete"</code>, <code>"darkgray"</code>, <code>"gray"</code>, <code>"platinum"</code>;   default: <code>"darkgray"</code></dt>

17774

<dd>The base floor type of the scales.

17775

</dd>

17776

<dt> adhesion,   values: number;   default: 2.0   See section <a href="#adhesion">adhesion</a></dt>

17777

<dt> friction,   values: number;   default: 4.0   See section <a href="#friction">friction</a></dt>

17778

<dt> burnable,   values: boolean;   default: depends on <code>flavor</code>   See section <a href="#burnable">burnable</a></dt>

17779

<dd>True if flavor is <code>"bridgewood"</code>, false otherwise.

17780

</dd>

17781

<dt> min   values: positive float number;   default: <code>+1.8</code></dt>

17782

<dd>Mass unit is the mass of an <a href="#ac_005fmarble">ac_marble</a>

17783

</dd>

17784

</dl>

17785

17786

</dd>

17787

<dt> Messages: none</dt>

17788

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

17789

<dt> Variants:</dt>

17790

17791

<dt> <img src="images/fl_scales_brick.png" alt="images/fl_scales_brick"> fl_scales_brick: flavor = <code>"brick"</code>

17792

</dt>

17793

<dt> <img src="images/fl_scales_bridge_bw_closed.png" alt="images/fl_scales_bridge_bw_closed"> fl_scales_bridgewood: flavor = <code>"bridgewood"</code>

17794

</dt>

17795

<dt> <img src="images/fl_scales_concrete.png" alt="images/fl_scales_concrete"> fl_scales_concrete: flavor = <code>"concrete"</code>

17796

</dt>

17797

<dt> <img src="images/fl_scales_darkgray.png" alt="images/fl_scales_darkgray"> fl_scales_darkgray: flavor = <code>"darkgray"</code>

17798

</dt>

17799

<dt> <img src="images/fl_scales_gray.png" alt="images/fl_scales_gray"> fl_scales_gray: flavor = <code>"gray"</code>

17800

</dt>

17801

<dt> <img src="images/fl_scales_platinum.png" alt="images/fl_scales_platinum"> fl_scales_platinum: flavor = <code>"platinum"</code>

17802

</dt>

17803

</dl>

17804

17805

</dd>

17806

</dl>

17807

17808

17809

17810

17811

17812

17813

17814

17815

17816

17817

17818

17819

17820

17821

17822

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

17823

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

17824

17825

</tr></table>

17826

17827

<h3 class="subsection">7.4.9 fl_slope</h3>

17828

17829

17830

A floor suited to build larger hills, gradient areas, wall brims, staircases

17831

or tubes that channelize actors.

17832

17833

Slope floors are basically described by their ‘<samp>slope</samp>’ and their ‘<samp>shape</samp>’.

17834

The slope is the orientation of the force applied to actors on top. The eight

17835

main orientations and ‘<samp>NODIR</samp>’, that causes no force to be applied at all, are

17836

currently supported.

17837

17838

The shape describes the intended usage, which causes a proper visual

17839

representation. There are planar slopes falling just into a horizontal or

17840

vertical direction (<code>"pw"</code>, <code>"ps"</code>, <code>"pe"</code>, <code>"pn"</code>),

17841

inner and outer edges falling into a diagonal direction (<code>"inw"</code>,

17842

<code>"isw"</code>, <code>"ise"</code>, <code>"ine"</code>, <code>"onw"</code>, <code>"osw"</code>,

17843

<code>"ose"</code>, <code>"one"</code>), tube center parts falling into a horizontal or

17844

vertical direction (<code>"tw"</code>, <code>"ts"</code>, <code>"te"</code>, <code>"tn"</code>) and

17845

tube left and right sides that accelerate actors into the main tube direction

17846

and back to the tube center at the same time (<code>"twl"</code>, <code>"tsl"</code>,

17847

<code>"tel"</code>, <code>"tnl"</code>, <code>"twr"</code>, <code>"tsr"</code>, <code>"ter"</code>,

17848

<code>"tnr"</code>).

17849

17850

Note that several shapes do currently use an identical visual representation.

17851

But they differ in their usage and different slope force orientations are

17852

assigned by default when you use the variant suffices. It is strongly

17853

recommended to use always the shape of the intended usage as the images might

17854

be improved in the future and should fit to your level.

17855

17856

The force applied to actors on the floor grid is given per default by the

17857

global attribute <a href="#SlopeStrength">SlopeStrength</a>. You may override this default by an

17858

explicit value for the slope floor attribute ‘<samp>strength</samp>’. In very special

17859

cases you may even define individual force components ‘<samp>force_x</samp>’ and

17860

‘<samp>force_y</samp>’, which will override all other slope force attributes.

17861

17862

17863

<dt> Attributes:</dt>

17864

<dd>

17865

17866

<dt> slope,   values: <code>NODIR</code>, <code>WEST</code>, <code>SOUTH</code>, <code>EAST</code>, <code>NORTH</code>, <code>NORTHWEST</code>, <code>SOUTHWEST</code>, <code>SOUTHEAST</code>, <code>NORTHEAST</code>;   default: <code>NODIR</code></dt>

17867

<dd>The orientation of the force. Note that setting this attribute does not

17868

automatically assign a fitting ‘<samp>shape</samp>’. This attribute is neglected if

17869

‘<samp>force_x</samp>’ or ‘<samp>force_y</samp>’ attributes are set.

17870

17871

</dd>

17872

<dt> shape,   values: <code>""</code>, <code>"pw"</code>, <code>"ps"</code>, <code>"pe"</code>, <code>"pn"</code>, <code>"inw"</code>, <code>"isw"</code>, <code>"ise"</code>, <code>"ine"</code>, <code>"onw"</code>, <code>"osw"</code>, <code>"ose"</code>, <code>"one"</code>, <code>"tw"</code>, <code>"ts"</code>, <code>"te"</code>, <code>"tn"</code>, <code>"twl"</code>, <code>"tsl"</code>, <code>"tel"</code>, <code>"tnl"</code>, <code>"twr"</code>, <code>"tsr"</code>, <code>"ter"</code>, <code>"tnr"</code>;   default: <code>""</code></dt>

17873

<dd>The intended usage as described above. Note that setting this attribute does

17874

not automatically assign the proper ‘<samp>slope</samp>’.

17875

17876

</dd>

17877

<dt> strength   values: float number;   default: <code>25.0</code>   See section <a href="#SlopeStrength">SlopeStrength</a></dt>

17878

<dt> force_x   values: float number;   default: <code>0.0</code>   See section <a href="#force_005fx">force_x</a></dt>

17879

<dt> force_y   values: float number;   default: <code>0.0</code>   See section <a href="#force_005fy">force_y</a></dt>

17880

<dt> adhesion,   values: number;   default: 2.0   See section <a href="#adhesion">adhesion</a></dt>

17881

<dt> friction,   values: number;   default: 4.0   See section <a href="#friction">friction</a></dt>

17882

<dt> burnable,   values: boolean;   default: false   See section <a href="#burnable">burnable</a></dt>

17883

</dl>

17884

17885

</dd>

17886

<dt> Messages: None</dt>

17887

<dt> Variants:</dt>

17888

17889

<tr><td width="8%"><img src="images/fl_slope_f.png" alt="images/fl_slope_f"></td><td width="42%">fl_slope slope = ‘<samp>NODIR</samp>’, shape = <code>""</code></td><td width="8%"></td><td width="42%"></td></tr>

17890

<tr><td width="8%"><img src="images/fl_slope_4.png" alt="images/fl_slope_4"></td><td width="42%">fl_slope_pw slope = ‘<samp>WEST</samp>’, shape = <code>"pw"</code></td><td width="8%"><img src="images/fl_slope.png" alt="images/fl_slope"></td><td width="42%">fl_slope_ps slope = ‘<samp>SOUTH</samp>’, shape = <code>"ps"</code></td></tr>

17891

<tr><td width="8%"><img src="images/fl_slope_3.png" alt="images/fl_slope_3"></td><td width="42%">fl_slope_pe slope = ‘<samp>EAST</samp>’, shape = <code>"pe"</code></td><td width="8%"><img src="images/fl_slope_2.png" alt="images/fl_slope_2"></td><td width="42%">fl_slope_pn slope = ‘<samp>NORTH</samp>’, shape = <code>"pn"</code></td></tr>

17892

<tr><td width="8%"><img src="images/fl_slope_c4.png" alt="images/fl_slope_c4"></td><td width="42%">fl_slope_inw slope = ‘<samp>NORTHWEST</samp>’, shape = <code>"inw"</code></td><td width="8%"><img src="images/fl_slope_c3.png" alt="images/fl_slope_c3"></td><td width="42%">fl_slope_isw slope = ‘<samp>SOUTHWEST</samp>’, shape = <code>"isw"</code></td></tr>

17893

<tr><td width="8%"><img src="images/fl_slope_c.png" alt="images/fl_slope_c"></td><td width="42%">fl_slope_ise slope = ‘<samp>SOUTHEAST</samp>’, shape = <code>"ise"</code></td><td width="8%"><img src="images/fl_slope_c2.png" alt="images/fl_slope_c2"></td><td width="42%">fl_slope_ine slope = ‘<samp>NORTHEAST</samp>’, shape = <code>"ine"</code></td></tr>

17894

<tr><td width="8%"><img src="images/fl_slope_b4.png" alt="images/fl_slope_b4"></td><td width="42%">fl_slope_onw slope = ‘<samp>NORTHWEST</samp>’, shape = <code>"onw"</code></td><td width="8%"><img src="images/fl_slope_b2.png" alt="images/fl_slope_b2"></td><td width="42%">fl_slope_osw slope = ‘<samp>SOUTHWEST</samp>’, shape = <code>"osw"</code></td></tr>

17895

<tr><td width="8%"><img src="images/fl_slope_b.png" alt="images/fl_slope_b"></td><td width="42%">fl_slope_ose slope = ‘<samp>SOUTHEAST</samp>’, shape = <code>"ose"</code></td><td width="8%"><img src="images/fl_slope_b3.png" alt="images/fl_slope_b3"></td><td width="42%">fl_slope_one slope = ‘<samp>NORTHEAST</samp>’, shape = <code>"one"</code></td></tr>

17896

<tr><td width="8%"><img src="images/fl_slope_f.png" alt="images/fl_slope_f"></td><td width="42%">fl_slope_tw slope = ‘<samp>WEST</samp>’, shape = <code>"tw"</code></td><td width="8%"><img src="images/fl_slope_f.png" alt="images/fl_slope_f"></td><td width="42%">fl_slope_ts slope = ‘<samp>SOUTH</samp>’, shape = <code>"ts"</code></td></tr>

17897

<tr><td width="8%"><img src="images/fl_slope_f.png" alt="images/fl_slope_f"></td><td width="42%">fl_slope_te slope = ‘<samp>EAST</samp>’, shape = <code>"te"</code></td><td width="8%"><img src="images/fl_slope_f.png" alt="images/fl_slope_f"></td><td width="42%">fl_slope_tn slope = ‘<samp>NORTH</samp>’, shape = <code>"tn"</code></td></tr>

17898

<tr><td width="8%"><img src="images/fl_slope_2.png" alt="images/fl_slope_2"></td><td width="42%">fl_slope_twl slope = ‘<samp>NORTHWEST</samp>’, shape = <code>"twl"</code></td><td width="8%"><img src="images/fl_slope_4.png" alt="images/fl_slope_4"></td><td width="42%">fl_slope_tsl slope = ‘<samp>SOUTHWEST</samp>’, shape = <code>"tsl"</code></td></tr>

17899

<tr><td width="8%"><img src="images/fl_slope.png" alt="images/fl_slope"></td><td width="42%">fl_slope_tel slope = ‘<samp>SOUTHEAST</samp>’, shape = <code>"tel"</code></td><td width="8%"><img src="images/fl_slope_3.png" alt="images/fl_slope_3"></td><td width="42%">fl_slope_tnl slope = ‘<samp>NORTHEAST</samp>’, shape = <code>"tnl"</code></td></tr>

17900

<tr><td width="8%"><img src="images/fl_slope.png" alt="images/fl_slope"></td><td width="42%">fl_slope_twr slope = ‘<samp>SOUTHWEST</samp>’, shape = <code>"twr"</code></td><td width="8%"><img src="images/fl_slope_3.png" alt="images/fl_slope_3"></td><td width="42%">fl_slope_tsr slope = ‘<samp>SOUTHEAST</samp>’, shape = <code>"tsr"</code></td></tr>

17901

<tr><td width="8%"><img src="images/fl_slope_2.png" alt="images/fl_slope_2"></td><td width="42%">fl_slope_ter slope = ‘<samp>NORTHEAST</samp>’, shape = <code>"ter"</code></td><td width="8%"><img src="images/fl_slope_4.png" alt="images/fl_slope_4"></td><td width="42%">fl_slope_tnr slope = ‘<samp>NORTHWEST</samp>’, shape = <code>"tnr"</code></td></tr>

17902

</table>

17903

</dd>

17904

</dl>

17905

17906

17907

17908

17909

17910

17911

17912

17913

17914

17915

17916

17917

17918

17919

17920

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

17921

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

17922

17923

</tr></table>

17924

17925

<h3 class="subsection">7.4.10 fl_swamp</h3>

17926

17927

17928

A swamp is very sticky floor caused by a high friction. Additionally ball like

17929

actors will sink in swamp. But the sink speed is limited and gives the user

17930

a certain time, defined by the global attribute <a href="#SwampSinkTime">SwampSinkTime</a>. When

17931

an actor moves faster than 6 grids per second, the actor start raising out of

17932

the swamp. Jumping in a swamp raises an actor, too.

17933

17934

A swamp is indestructible to the aspect that <a href="#it_005fcrack">it_crack</a> will not spread

17935

onto it. But fire starting to burn nearby will dry out the swamp to

17936

<a href="#fl_005fdunes">fl_dunes</a> (see section <a href="#Heat_002dTransformation">Heat-Transformation</a>). A swamp itself may be a successor of

17937

a <a href="#fl_005fwater">fl_water</a> heated by a fire.

17938

17939

17940

<dt> Attributes:</dt>

17941

17942

<dt> adhesion,   values: number;   default: 1.0   See section <a href="#adhesion">adhesion</a></dt>

17943

<dt> friction,   values: number;   default: 13.0   See section <a href="#friction">friction</a></dt>

17944

<dt> indestructible,   values: bool ;   default: true;   access: <code>none</code>   See section <a href="#indestructible">indestructible</a></dt>

17945

<dt> burnable,   values: boolean;   default: false   See section <a href="#burnable">burnable</a></dt>

17946

</dl>

17947

17948

</dd>

17949

<dt> Variants:</dt>

17950

17951

<dt> <img src="images/fl_swamp.png" alt="images/fl_swamp"> fl_swamp

17952

</dt>

17953

</dl>

17954

</dd>

17955

</dl>

17956

17957

17958

17959

17960

17961

17962

17963

17964

17965

17966

17967

17968

17969

17970

17971

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

17972

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

17973

17974

</tr></table>

17975

17976

<h3 class="subsection">7.4.11 fl_thief</h3>

17977

17978

17979

A thief steals the item on its position plus an item from the player’s inventory

17980

when it is entered by an owned actor. Unfortunately the thief floor is visually

17981

indistinguishable from an <a href="#fl_005fbluegray">fl_bluegray</a> and has even the same

17982

‘<samp>friction</samp>’ and ‘<samp>adhesion</samp>’ values.

17983

17984

The item is not directly stolen at the moment of entering the grid. The entering

17985

itself just causes the thief to emerge from his hiding-place. The thief steals

17986

from the actor that did conjure him at the moment of maximum visibility. He takes

17987

a random item from the owner’s inventory. But he just will steal an item if

17988

the actor is not shielded due to an activated <a href="#it_005fumbrella">it_umbrella</a>.

17989

17990

Thieves have an addiction to alcohol. Thus they get drunken and inactive if

17991

they happen to steal a bottle filled with stuff.

17992

17993

Thieves have an enemy - the <a href="#st_005fchess">st_chess</a>. If a chess stone is pushed onto

17994

a thief it will capture the thief, sober or drunken. The thief vanishes leaving

17995

an inactive standard floor and the chess stone jumps onto its position. But the

17996

thief will leave behind on the grid all stolen items in his own <a href="#it_005fbag">it_bag</a>.

17997

If the thief has not stolen any items he leaves no empty bag.

17998

17999

18000

<dt> Attributes: none</dt>

18001

18002

<dt> adhesion,   values: number;   default: 1.5   See section <a href="#adhesion">adhesion</a></dt>

18003

<dt> friction,   values: number;   default: 4.5   See section <a href="#friction">friction</a></dt>

18004

<dt> burnable,   values: boolean;   default: false   See section <a href="#burnable">burnable</a></dt>

18005

</dl>

18006

18007

</dd>

18008

<dt> Messages: none</dt>

18009

<dt> Action: none</dt>

18010

<dt> Variants:</dt>

18011

18012

<dt> <img src="images/fl_bluegray.png" alt="images/fl_bluegray"> fl_thief: hidden

18013

</dt>

18014

<dt> <img src="images/fl_thief.png" alt="images/fl_thief"> fl_thief: showing up at the moment when stealing items

18015

</dt>

18016

<dt> <img src="images/fl_thief_capture.png" alt="images/fl_thief_capture"> fl_thief: when being captured

18017

</dt>

18018

<dt> <img src="images/fl_thief_drunken.png" alt="images/fl_thief_drunken"> fl_thief: drunken thief

18019

</dt>

18020

</dl>

18021

</dd>

18022

</dl>

18023

18024

18025

18026

18027

18028

18029

18030

18031

18032

18033

18034

18035

18036

18037

18038

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

18039

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

18040

18041

</tr></table>

18042

18043

<h3 class="subsection">7.4.12 fl_water</h3>

18044

18045

18046

Besides <a href="#fl_005fabyss">fl_abyss</a> water is the second natural floor barrier for ball like

18047

actors, as they can not easily pass it.

18048

18049

Both, <a href="#ac_005fmarble">ac_marble</a> and <a href="#ac_005fpearl">ac_pearl</a>, will sink in water, usually at once,

18050

but the time amount can be configured by the global attribute <a href="#WaterSinkTime">WaterSinkTime</a>.

18051

Unlike <a href="#fl_005fswamp">fl_swamp</a> water does not raise fast moving actors. But jumping

18052

within water raises an actor. Jumping completely over a water chasm is of course

18053

a more standard way to cross it. Actors protected by an activated

18054

<a href="#it_005fumbrella">it_umbrella</a> can pass and even move on water without restrictions.

18055

18056

Some stones fall into water, too. <a href="#st_005fbox">st_box</a> will build floors on which all

18057

actors can move and pass the former water filled grid.

18058

18059

Water itself is indestructible to the aspect that <a href="#it_005fcrack">it_crack</a> will not spread

18060

onto it. But a fire starting to burn nearby will dry out the water to

18061

<a href="#fl_005fswamp">fl_swamp</a> (see <a href="#Heat_002dTransformation">Heat-Transformation</a>).

18062

18063

The standard water is static, its ‘<samp>state</samp>’ is ‘<samp>IDLE</samp>’. It will not

18064

spread to adjacent floors. But you can set up flood streams that will fill areas

18065

or flow through given paths. You just need to define the area by setting the

18066

attribute ‘<samp>floodable</samp>’ to ‘<samp>true</samp>’ on the affected floors. But static

18067

water lakes do not require an additional ‘<samp>floodable</samp>’ attribute, as they

18068

are floodable by default.

18069

18070

As soon as you add a ‘<samp>fl_water_source</samp>’ or set the ‘<samp>state</samp>’ to

18071

‘<samp>FLOODING</samp>’, the water starts to spread to floodable neighboring grids with

18072

a speed defined by the attribute ‘<samp>interval</samp>’. The speed will be inherited to

18073

floors flooded by a stream.

18074

18075

As a flood can be influenced by many obstacles and may sink some stones itself,

18076

you will find a complete discussion in the section <a href="#Flood-Spreading">Flood Spreading</a>.

18077

18078

18079

<dt> Attributes:</dt>

18080

18081

<dt> state,   values: <code>IDLE</code>, <code>FLOODING</code>;   default: <code>IDLE</code>   See section <a href="#state">state</a></dt>

18082

<dt> interval   values: positive number;   default: <code>0.2</code></dt>

18083

<dd>Number of seconds .

18084

</dd>

18085

<dt> indestructible,   values: bool ;   default: true;   access: <code>none</code>   See section <a href="#indestructible">indestructible</a></dt>

18086

<dt> adhesion,   values: number;   default: 1.0   See section <a href="#adhesion">adhesion</a></dt>

18087

<dt> friction,   values: number;   default: 5.0   See section <a href="#friction">friction</a></dt>

18088

<dt> burnable,   values: boolean;   default: false   See section <a href="#burnable">burnable</a></dt>

18089

</dl>

18090

18091

</dd>

18092

<dt> Variants:</dt>

18093

18094

<dt> <img src="images/fl_water.png" alt="images/fl_water"> fl_water: state = <code>IDLE</code>

18095

</dt>

18096

<dt> <img src="images/fl_water.png" alt="images/fl_water"> fl_water_source: state = <code>FLOODING</code>

18097

</dt>

18098

</dl>

18099

</dd>

18100

</dl>

18101

18102

18103

18104

18105

18106

18107

18108

18109

18110

18111

18112

18113

18114

18115

18116

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

18117

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

18118

18119

</tr></table>

18120

18121

18122

18123

18124

A wooden floor is in most aspects a standard floor, that exists in textures

18125

with horizontal or vertical panels, or random. All textures come in a framed

18126

variation, too.

18127

18128

The framed variant is the successor of a fallen <a href="#st_005fbox">st_box</a>_wood. It may be

18129

flooded by a <a href="#fl_005fwater">fl_water</a> stream without the attribute ‘<samp>floodable</samp>’ being

18130

set to ‘<samp>true</samp>’ as the flood passes below this floor. The framed wood

18131

acts like a bridge over a flood stream and the water will continue to spread to

18132

neighboring grids, while the framed wood is still passable for actors. In fact

18133

a framed wood can even operate as a flood source, but we do not recommend this

18134

usage. see section <a href="#Flood-Spreading">Flood Spreading</a>.

18135

18136

When burnt, <code>fl_wood</code> becomes <a href="#fl_005fabyss">fl_abyss</a>.

18137

18138

18139

<dt> Attributes:</dt>

18140

18141

<dt> state,   values: <code>IDLE</code>, <code>FLOODING</code>;   default: <code>IDLE</code>   See section <a href="#state">state</a></dt>

18142

<dt> interval   values: positive number;   default: <code>0.2</code></dt>

18143

<dd>Number of seconds .

18144

</dd>

18145

<dt> adhesion,   values: number;   default: 2.0   See section <a href="#adhesion">adhesion</a></dt>

18146

<dt> friction,   values: number;   default: 6.4   See section <a href="#friction">friction</a></dt>

18147

<dt> burnable,   values: boolean;   default: true   See section <a href="#burnable">burnable</a></dt>

18148

</dl>

18149

18150

</dd>

18151

<dt> Variants:</dt>

18152

18153

<dt> <img src="images/fl_wood.png" alt="images/fl_wood"> fl_wood: texture = random

18154

</dt>

18155

<dt> <img src="images/fl_wood_3.png" alt="images/fl_wood_3"> fl_wood_h: texture = <code>"h"</code>

18156

</dt>

18157

<dt> <img src="images/fl_wood.png" alt="images/fl_wood"> fl_wood_v: texture = <code>"v"</code>

18158

</dt>

18159

<dt> <img src="images/fl_wood_framed.png" alt="images/fl_wood_framed"> fl_wood_framed: texture = random, faces = <code>"nesw"</code>

18160

</dt>

18161

<dt> <img src="images/fl_wood_framed.png" alt="images/fl_wood_framed"> fl_wood_framed_h: texture = <code>"h"</code>, faces = <code>"nesw"</code>

18162

</dt>

18163

<dt> <img src="images/fl_wood_framed_2.png" alt="images/fl_wood_framed_2"> fl_wood_framed_v: texture = <code>"v"</code>, faces = <code>"nesw"</code>

18164

</dt>

18165

</dl>

18166

</dd>

18167

</dl>

18168

18169

18170

18171

18172

18173

18174

18175

18176

18177

18178

18179

18180

18181

18182

18183

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

18184

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

18185

18186

</tr></table>

18187

18188

<h3 class="subsection">7.4.14 fl_yinyang</h3>

18189

18190

18191

A floor that lets move just actors assigned to one player. A basic floor color

18192

of dark gray corresponds to ‘<samp>YIN</samp>’ and lets accelerate just actors that

18193

are controlled by this first player. White colored yinyang floors correspond

18194

to ‘<samp>YANG</samp>’ and let accelerate just actors controlled by this second player.

18195

18196

The floor image with 4 rivets in the corners shows an additional yinyang symbol

18197

to visualize that not the color of the actor is essential but the controlling

18198

player. In large areas of this floor this symbol is disturbing and it can be

18199

switched off by the attribute ‘<samp>invisible</samp>’.

18200

18201

18202

<dt> Attributes:</dt>

18203

18204

<dt> state,   values: <code>YIN</code>, <code>YANG</code>;   default: <code>YIN</code>   See section <a href="#state">state</a></dt>

18205

<dt> invisible   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

18206

<dt> adhesion,   values: number;   default: 2.0   See section <a href="#adhesion">adhesion</a></dt>

18207

<dt> friction,   values: number;   default: 5.2   See section <a href="#friction">friction</a></dt>

18208

<dt> burnable,   values: boolean;   default: false   See section <a href="#burnable">burnable</a></dt>

18209

</dl>

18210

18211

</dd>

18212

<dt> Variants:</dt>

18213

18214

<dt> <img src="images/fl_yinyang_yin.png" alt="images/fl_yinyang_yin"> fl_yinyang: state = <code>YIN</code>

18215

</dt>

18216

<dt> <img src="images/fl_yinyang_yin.png" alt="images/fl_yinyang_yin"> fl_yinyang_yin: state = <code>YIN</code>

18217

</dt>

18218

<dt> <img src="images/fl_yinyang_yang.png" alt="images/fl_yinyang_yang"> fl_yinyang_yang: state = <code>YANG</code>

18219

</dt>

18220

</dl>

18221

</dd>

18222

</dl>

18223

18224

18225

18226

18227

18228

18229

18230

18231

18232

18233

18234

18235

18236

18237

18238

18239

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

18240

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

18241

18242

</tr></table>

18243

18244

<h1 class="chapter">8. Item Objects</h1>

18245

18246

18247

<tr><td align="left" valign="top"><a href="#Item-Overview">8.1 Item Overview</a></td><td>  </td><td align="left" valign="top">

18248

</td></tr>

18249

<tr><td align="left" valign="top"><a href="#Item-Attributes">8.2 Item Attributes</a></td><td>  </td><td align="left" valign="top">

18250

</td></tr>

18251

<tr><td align="left" valign="top"><a href="#Liftable-Items">8.3 Liftable Items</a></td><td>  </td><td align="left" valign="top">

18252

</td></tr>

18253

<tr><td align="left" valign="top"><a href="#Static-Items">8.4 Static Items</a></td><td>  </td><td align="left" valign="top">

18254

</td></tr>

18255

</table>

18256

18257

18258

18259

18260

18261

18262

18263

18264

18265

18266

18267

18268

18269

18270

18271

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

18272

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

18273

18274

</tr></table>

18275

18276

<h2 class="section">8.1 Item Overview</h2>

18277

18278

<table>

18279

<tr><td width="8%"><img src="images/it_bag.png" alt="images/it_bag"></td><td width="25%"><a href="#it_005fbag">it_bag</a></td><td width="8%"><img src="images/it_banana.png" alt="images/it_banana"></td><td width="25%"><a href="#it_005fbanana">it_banana</a></td><td width="9%"><img src="images/st_blocker_4.png" alt="images/st_blocker_4"></td><td width="25%"><a href="#it_005fblocker">it_blocker</a></td></tr>

18280

<tr><td width="8%"><img src="images/it_bomb.png" alt="images/it_bomb"></td><td width="25%"><a href="#it_005fbomb">it_bomb</a>_black</td><td width="8%"><img src="images/it_bomb_b.png" alt="images/it_bomb_b"></td><td width="25%"><a href="#it_005fbomb">it_bomb</a>_white</td><td width="9%"><img src="images/it_bottle_idle.png" alt="images/it_bottle_idle"></td><td width="25%"><a href="#it_005fbottle">it_bottle</a></td></tr>

18281

<tr><td width="8%"><img src="images/it_bottle_broken.png" alt="images/it_bottle_broken"></td><td width="25%"><a href="#it_005fbottle">it_bottle</a>_broken</td><td width="8%"><img src="images/st_brake.png" alt="images/st_brake"></td><td width="25%"><a href="#it_005fbrake">it_brake</a></td><td width="9%"><img src="images/it_brush.png" alt="images/it_brush"></td><td width="25%"><a href="#it_005fbrush">it_brush</a></td></tr>

18282

<tr><td width="8%"><img src="images/it_burnable_ash.png" alt="images/it_burnable_ash"></td><td width="25%"><a href="#it_005fburnable">it_burnable</a>_ash</td><td width="8%"><img src="images/it_burnable_burning.png" alt="images/it_burnable_burning"></td><td width="25%"><a href="#it_005fburnable">it_burnable</a>_burning</td><td width="9%"><img src="images/it_burnable_fireproof.png" alt="images/it_burnable_fireproof"></td><td width="25%"><a href="#it_005fburnable">it_burnable</a>_fireproof</td></tr>

18283

<tr><td width="8%"><img src="images/it_burnable_oil.png" alt="images/it_burnable_oil"></td><td width="25%"><a href="#it_005fburnable">it_burnable</a>_oil</td><td width="8%"><img src="images/it_cherry.png" alt="images/it_cherry"></td><td width="25%"><a href="#it_005fcherry">it_cherry</a></td><td width="9%"><img src="images/it_coffee.png" alt="images/it_coffee"></td><td width="25%"><a href="#it_005fcoffee">it_coffee</a></td></tr>

18284

18285

<tr><td width="8%"><img src="images/it_crack_abyss.png" alt="images/it_crack_abyss"></td><td width="25%"><a href="#it_005fcrack">it_crack</a>_abyss</td><td width="8%"><img src="images/it_crack_water.png" alt="images/it_crack_water"></td><td width="25%"><a href="#it_005fcrack">it_crack</a>_water</td><td width="9%"><img src="images/it_cross.png" alt="images/it_cross"></td><td width="25%"><a href="#it_005fcross">it_cross</a></td></tr>

18286

<tr><td width="8%"><img src="images/it_death.png" alt="images/it_death"></td><td width="25%"><a href="#it_005fdeath">it_death</a></td><td width="8%"><img src="images/it_document.png" alt="images/it_document"></td><td width="25%"><a href="#it_005fdocument">it_document</a></td><td width="9%"><img src="images/it_drop.png" alt="images/it_drop"></td><td width="25%"><a href="#it_005fdrop">it_drop</a></td></tr>

18287

<tr><td width="8%"><img src="images/it_dynamite.png" alt="images/it_dynamite"></td><td width="25%"><a href="#it_005fdynamite">it_dynamite</a></td><td width="8%"><img src="images/it_explosion.png" alt="images/it_explosion"></td><td width="25%"><a href="#it_005fexplosion">it_explosion</a></td><td width="9%"><img src="images/it_extinguisher.png" alt="images/it_extinguisher"></td><td width="25%"><a href="#it_005fextinguisher">it_extinguisher</a></td></tr>

18288

<tr><td width="8%"><img src="images/it_extralife.png" alt="images/it_extralife"></td><td width="25%"><a href="#it_005fextralife">it_extralife</a></td><td width="8%"><img src="images/it_flag_black.png" alt="images/it_flag_black"></td><td width="25%"><a href="#it_005fflag">it_flag</a>_black</td><td width="9%"><img src="images/it_flag_white.png" alt="images/it_flag_white"></td><td width="25%"><a href="#it_005fflag">it_flag</a>_white</td></tr>

18289

<tr><td width="8%"><img src="images/it_floppy.png" alt="images/it_floppy"></td><td width="25%"><a href="#it_005ffloppy">it_floppy</a></td><td width="8%"><img src="images/it_glasses.png" alt="images/it_glasses"></td><td width="25%"><a href="#it_005fglasses">it_glasses</a></td><td width="9%"><img src="images/it_glasses_broken.png" alt="images/it_glasses_broken"></td><td width="25%"><a href="#it_005fglasses">it_glasses</a>_broken</td></tr>

18290

<tr><td width="8%"><img src="images/it_hammer.png" alt="images/it_hammer"></td><td width="25%"><a href="#it_005fhammer">it_hammer</a></td><td width="8%"><img src="images/it_key.png" alt="images/it_key"></td><td width="25%"><a href="#it_005fkey">it_key</a></td><td width="9%"><img src="images/it_landmine.png" alt="images/it_landmine"></td><td width="25%"><a href="#it_005flandmine">it_landmine</a></td></tr>

18291

<tr><td width="8%"><img src="images/it_laser.png" alt="images/it_laser"></td><td width="25%"><a href="#it_005flaserbeam">it_laserbeam</a></td><td width="8%"><img src="images/it_magicwand.png" alt="images/it_magicwand"></td><td width="25%"><a href="#it_005fmagicwand">it_magicwand</a></td><td width="9%"><img src="images/it_magnet_off.png" alt="images/it_magnet_off"></td><td width="25%"><a href="#it_005fmagnet">it_magnet</a></td></tr>

18292

<tr><td width="8%"><img src="images/it_meditation_bump.png" alt="images/it_meditation_bump"></td><td width="25%"><a href="#it_005fmeditation">it_meditation</a>_bump</td><td width="8%"><img src="images/it_meditation_caldera.png" alt="images/it_meditation_caldera"></td><td width="25%"><a href="#it_005fmeditation">it_meditation</a>_caldera</td><td width="9%"><img src="images/it_meditation_dent.png" alt="images/it_meditation_dent"></td><td width="25%"><a href="#it_005fmeditation">it_meditation</a>_dent</td></tr>

18293

<tr><td width="8%"><img src="images/it_meditation_hill.png" alt="images/it_meditation_hill"></td><td width="25%"><a href="#it_005fmeditation">it_meditation</a>_hill</td><td width="8%"><img src="images/it_meditation_hollow.png" alt="images/it_meditation_hollow"></td><td width="25%"><a href="#it_005fmeditation">it_meditation</a>_hollow</td><td width="9%"><img src="images/it_meditation_volcano.png" alt="images/it_meditation_volcano"></td><td width="25%"><a href="#it_005fmeditation">it_meditation</a>_volcano</td></tr>

18294

<tr><td width="8%"><img src="images/it_pencil.png" alt="images/it_pencil"></td><td width="25%"><a href="#it_005fpencil">it_pencil</a></td><td width="8%"><img src="images/it_pin.png" alt="images/it_pin"></td><td width="25%"><a href="#it_005fpin">it_pin</a></td><td width="9%"><img src="images/it_pipe_e.png" alt="images/it_pipe_e"></td><td width="25%"><a href="#it_005fpipe">it_pipe</a></td></tr>

18295

<tr><td width="8%"><img src="images/it_puller.png" alt="images/it_puller"></td><td width="25%"><a href="#it_005fpuller">it_puller</a></td><td width="8%"><img src="images/it_ring.png" alt="images/it_ring"></td><td width="25%"><a href="#it_005fring">it_ring</a></td><td width="9%"><img src="images/it_rubberband.png" alt="images/it_rubberband"></td><td width="25%"><a href="#it_005frubberband">it_rubberband</a></td></tr>

18296

<tr><td width="8%"><img src="images/it_seed.png" alt="images/it_seed"></td><td width="25%"><a href="#it_005fseed">it_seed</a></td><td width="8%"><img src="images/it_sensor.png" alt="images/it_sensor"></td><td width="25%"><a href="#it_005fsensor">it_sensor</a></td><td width="9%"><img src="images/it_sensor_exit.png" alt="images/it_sensor_exit"></td><td width="25%"><a href="#it_005fsensor">it_sensor</a>_exit</td></tr>

18297

<tr><td width="8%"><img src="images/it_shogun_m.png" alt="images/it_shogun_m"></td><td width="25%"><a href="#it_005fshogun">it_shogun</a></td><td width="8%"><img src="images/it_spade.png" alt="images/it_spade"></td><td width="25%"><a href="#it_005fspade">it_spade</a></td><td width="9%"><img src="images/it_spoon.png" alt="images/it_spoon"></td><td width="25%"><a href="#it_005fspoon">it_spoon</a></td></tr>

18298

<tr><td width="8%"><img src="images/it_springboard.png" alt="images/it_springboard"></td><td width="25%"><a href="#it_005fspringboard">it_springboard</a></td><td width="8%"><img src="images/it_spring_2.png" alt="images/it_spring_2"></td><td width="25%"><a href="#it_005fspring">it_spring</a>_drop</td><td width="9%"><img src="images/it_spring.png" alt="images/it_spring"></td><td width="25%"><a href="#it_005fspring">it_spring</a>_keep</td></tr>

18299

<tr><td width="8%"><img src="images/it_squashed.png" alt="images/it_squashed"></td><td width="25%"><a href="#it_005fsquashed">it_squashed</a></td><td width="8%"><img src="images/it_strip_b2.png" alt="images/it_strip_b2"></td><td width="25%"><a href="#it_005fstrip">it_strip</a>_ew</td><td width="9%"><img src="images/it_surprise.png" alt="images/it_surprise"></td><td width="25%"><a href="#it_005fsurprise">it_surprise</a></td></tr>

18300

<tr><td width="8%"><img src="images/it_sword.png" alt="images/it_sword"></td><td width="25%"><a href="#it_005fsword">it_sword</a></td><td width="8%"><img src="images/it_trap.png" alt="images/it_trap"></td><td width="25%"><a href="#it_005ftrap">it_trap</a></td><td width="9%"><img src="images/it_trigger.png" alt="images/it_trigger"></td><td width="25%"><a href="#it_005ftrigger">it_trigger</a></td></tr>

18301

<tr><td width="8%"><img src="images/it_umbrella.png" alt="images/it_umbrella"></td><td width="25%"><a href="#it_005fumbrella">it_umbrella</a></td><td width="8%"><img src="images/it_vortex.png" alt="images/it_vortex"></td><td width="25%"><a href="#it_005fvortex">it_vortex</a></td><td width="9%"><img src="images/it_weight.png" alt="images/it_weight"></td><td width="25%"><a href="#it_005fweight">it_weight</a></td></tr>

18302

<tr><td width="8%"><img src="images/it_wormhole.png" alt="images/it_wormhole"></td><td width="25%"><a href="#it_005fwormhole">it_wormhole</a></td><td width="8%"><img src="images/it_wrench.png" alt="images/it_wrench"></td><td width="25%"><a href="#it_005fwrench">it_wrench</a></td><td width="9%"><img src="images/it_yinyang.png" alt="images/it_yinyang"></td><td width="25%"><a href="#it_005fyinyang">it_yinyang</a></td></tr>

18303

</table>

18304

18305

18306

18307

18308

18309

18310

18311

18312

18313

18314

18315

18316

18317

18318

18319

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

18320

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

18321

18322

</tr></table>

18323

18324

<h2 class="section">8.2 Item Attributes</h2>

18325

18326

18327

<tr><td align="left" valign="top"><a href="#fireproof">8.2.1 fireproof</a></td><td>  </td><td align="left" valign="top"> -

18328

</td></tr>

18329

<tr><td align="left" valign="top"><a href="#freezable">8.2.2 freezable</a></td><td>  </td><td align="left" valign="top"> Affinity to be frozen in ice

18330

</td></tr>

18331

<tr><td align="left" valign="top"><a href="#liftable">8.2.3 liftable</a></td><td>  </td><td align="left" valign="top"> Allowance for actors to pick up

18332

</td></tr>

18333

<tr><td align="left" valign="top"><a href="#portable">8.2.4 portable</a></td><td>  </td><td align="left" valign="top"> Ability to be added to the inventory

18334

</td></tr>

18335

</table>

18336

18337

18338

18339

18340

18341

18342

18343

18344

18345

18346

18347

18348

18349

18350

18351

18352

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

18353

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

18354

18355

</tr></table>

18356

18357

<h3 class="subsection">8.2.1 fireproof</h3>

18358

18359

18360

18361

<dt> Type:   boolean</dt>

18362

<dt> Values:   <code>false</code>, <code>true</code></dt>

18363

<dt> Default:   <code>false</code></dt>

18364

<dt> Access:   read/write</dt>

18365

</dl>

18366

18367

18368

18369

18370

18371

18372

18373

18374

18375

18376

18377

18378

18379

18380

18381

18382

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

18383

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

18384

18385

</tr></table>

18386

18387

<h3 class="subsection">8.2.2 freezable</h3>

18388

18389

Describes the affinity of an item to be frozen by an <a href="#st_005fice">st_ice</a>. All

18390

<a href="#portable">portable</a> items a freezable. But some otherwise static items may be

18391

freezable, too.

18392

18393

18394

<dt> Type:   boolean</dt>

18395

<dt> Values:   <code>false</code>, <code>true</code></dt>

18396

<dt> Default:   <code>false</code></dt>

18397

<dt> Access:   read only</dt>

18398

</dl>

18399

18400

18401

18402

18403

18404

18405

18406

18407

18408

18409

18410

18411

18412

18413

18414

18415

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

18416

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

18417

18418

</tr></table>

18419

18420

<h3 class="subsection">8.2.3 liftable</h3>

18421

18422

Describes the ability of <a href="#Actors">Actors</a> to pick up an item from a floor. Note

18423

that some items can be added to the player’s inventory and can be dropped onto

18424

a floor but nevertheless can not be picked up later on.

18425

18426

18427

<dt> Type:   boolean</dt>

18428

<dt> Values:   <code>false</code>, <code>true</code></dt>

18429

<dt> Default:   <code>false</code></dt>

18430

<dt> Access:   read only</dt>

18431

</dl>

18432

18433

18434

18435

18436

18437

18438

18439

18440

18441

18442

18443

18444

18445

18446

18447

18448

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

18449

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

18450

18451

</tr></table>

18452

18453

<h3 class="subsection">8.2.4 portable</h3>

18454

18455

Determines whether an item can be added to the player’s inventory. All

18456

<a href="#liftable">liftable</a> items are portable. Portable items that are not liftable can

18457

either be added to the inventory by means of the world <a href="#add">add</a> method or

18458

by an actor hitting a variant of <a href="#st_005fdispenser">st_dispenser</a>.

18459

18460

18461

<dt> Type:   boolean</dt>

18462

<dt> Values:   <code>false</code>, <code>true</code></dt>

18463

<dt> Default:   <code>false</code></dt>

18464

<dt> Access:   read only</dt>

18465

</dl>

18466

18467

18468

18469

18470

18471

18472

18473

18474

18475

18476

18477

18478

18479

18480

18481

18482

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

18483

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

18484

18485

</tr></table>

18486

18487

<h2 class="section">8.3 Liftable Items</h2>

18488

18489

18490

<tr><td align="left" valign="top"><a href="#it_005fbag">8.3.1 it_bag</a></td><td>  </td><td align="left" valign="top"> Portable Item Container

18491

</td></tr>

18492

<tr><td align="left" valign="top"><a href="#it_005fbanana">8.3.2 it_banana</a></td><td>  </td><td align="left" valign="top"> Transformable Banana

18493

</td></tr>

18494

<tr><td align="left" valign="top"><a href="#it_005fbottle">8.3.3 it_bottle</a></td><td>  </td><td align="left" valign="top"> Bottle of Booze

18495

</td></tr>

18496

<tr><td align="left" valign="top"><a href="#it_005fbrake">8.3.4 it_brake</a></td><td>  </td><td align="left" valign="top"> Portable Stone Brake

18497

</td></tr>

18498

<tr><td align="left" valign="top"><a href="#it_005fbrush">8.3.5 it_brush</a></td><td>  </td><td align="left" valign="top"> Brush for Painting and Sweeping

18499

</td></tr>

18500

<tr><td align="left" valign="top"><a href="#it_005fcherry">8.3.6 it_cherry</a></td><td>  </td><td align="left" valign="top"> Source of Invisibility

18501

</td></tr>

18502

<tr><td align="left" valign="top"><a href="#it_005fcoffee">8.3.7 it_coffee</a></td><td>  </td><td align="left" valign="top"> Cup of Coffee

18503

</td></tr>

18504

<tr><td align="left" valign="top"><a href="#it_005fcoin">8.3.8 it_coin</a></td><td>  </td><td align="left" valign="top"> Enigma’s currency

18505

</td></tr>

18506

<tr><td align="left" valign="top"><a href="#it_005fdocument">8.3.9 it_document</a></td><td>  </td><td align="left" valign="top"> Readable Text Document

18507

</td></tr>

18508

<tr><td align="left" valign="top"><a href="#it_005fdrop">8.3.10 it_drop</a></td><td>  </td><td align="left" valign="top"> Magic Transformation Elixir

18509

</td></tr>

18510

<tr><td align="left" valign="top"><a href="#it_005fdynamite">8.3.11 it_dynamite</a></td><td>  </td><td align="left" valign="top"> Exploder

18511

</td></tr>

18512

<tr><td align="left" valign="top"><a href="#it_005fextinguisher">8.3.12 it_extinguisher</a></td><td>  </td><td align="left" valign="top"> Fire Extinguisher

18513

</td></tr>

18514

<tr><td align="left" valign="top"><a href="#it_005fextralife">8.3.13 it_extralife</a></td><td>  </td><td align="left" valign="top"> Another Life or Glasses

18515

</td></tr>

18516

<tr><td align="left" valign="top"><a href="#it_005fflag">8.3.14 it_flag</a></td><td>  </td><td align="left" valign="top"> Respawn Position Marker

18517

</td></tr>

18518

<tr><td align="left" valign="top"><a href="#it_005ffloppy">8.3.15 it_floppy</a></td><td>  </td><td align="left" valign="top"> Lock opening uncoded Floppy

18519

</td></tr>

18520

<tr><td align="left" valign="top"><a href="#it_005fglasses">8.3.16 it_glasses</a></td><td>  </td><td align="left" valign="top"> Glasses to spot certain objects

18521

</td></tr>

18522

<tr><td align="left" valign="top"><a href="#it_005fhammer">8.3.17 it_hammer</a></td><td>  </td><td align="left" valign="top"> Stone breaking Hammer

18523

</td></tr>

18524

<tr><td align="left" valign="top"><a href="#it_005fkey">8.3.18 it_key</a></td><td>  </td><td align="left" valign="top"> Lock opening coded Key

18525

</td></tr>

18526

<tr><td align="left" valign="top"><a href="#it_005fmagicwand">8.3.19 it_magicwand</a></td><td>  </td><td align="left" valign="top"> Wizards Tools

18527

</td></tr>

18528

<tr><td align="left" valign="top"><a href="#it_005fpencil">8.3.20 it_pencil</a></td><td>  </td><td align="left" valign="top"> Pencil to mark Objects

18529

</td></tr>

18530

<tr><td align="left" valign="top"><a href="#it_005fpin">8.3.21 it_pin</a></td><td>  </td><td align="left" valign="top"> Friction increasing crampon

18531

</td></tr>

18532

<tr><td align="left" valign="top"><a href="#it_005fpipe">8.3.22 it_pipe</a></td><td>  </td><td align="left" valign="top"> Pipe for Transmissions

18533

</td></tr>

18534

<tr><td align="left" valign="top"><a href="#it_005fpuller">8.3.23 it_puller</a></td><td>  </td><td align="left" valign="top"> Stone pulling item

18535

</td></tr>

18536

<tr><td align="left" valign="top"><a href="#it_005fring">8.3.24 it_ring</a></td><td>  </td><td align="left" valign="top"> Position Exchange Tool

18537

</td></tr>

18538

<tr><td align="left" valign="top"><a href="#it_005frubberband">8.3.25 it_rubberband</a></td><td>  </td><td align="left" valign="top"> Unconnected Rubberband

18539

</td></tr>

18540

<tr><td align="left" valign="top"><a href="#it_005fseed">8.3.26 it_seed</a></td><td>  </td><td align="left" valign="top"> Seeds for Wood, Volcano Stones

18541

</td></tr>

18542

<tr><td align="left" valign="top"><a href="#it_005fspade">8.3.27 it_spade</a></td><td>  </td><td align="left" valign="top"> Shuffle for Meditation flattening

18543

</td></tr>

18544

<tr><td align="left" valign="top"><a href="#it_005fspoon">8.3.28 it_spoon</a></td><td>  </td><td align="left" valign="top"> Controlled Suicide Tool

18545

</td></tr>

18546

<tr><td align="left" valign="top"><a href="#it_005fspring">8.3.29 it_spring</a></td><td>  </td><td align="left" valign="top"> Portable Spring

18547

</td></tr>

18548

<tr><td align="left" valign="top"><a href="#it_005fsurprise">8.3.30 it_surprise</a></td><td>  </td><td align="left" valign="top"> Random Transforming item

18549

</td></tr>

18550

<tr><td align="left" valign="top"><a href="#it_005fsword">8.3.31 it_sword</a></td><td>  </td><td align="left" valign="top"> Knight defeating Sword

18551

</td></tr>

18552

<tr><td align="left" valign="top"><a href="#it_005fumbrella">8.3.32 it_umbrella</a></td><td>  </td><td align="left" valign="top"> Death Protection Item

18553

</td></tr>

18554

<tr><td align="left" valign="top"><a href="#it_005fweight">8.3.33 it_weight</a></td><td>  </td><td align="left" valign="top"> Portable Mass

18555

</td></tr>

18556

<tr><td align="left" valign="top"><a href="#it_005fwrench">8.3.34 it_wrench</a></td><td>  </td><td align="left" valign="top"> Tool for mechanical Stones

18557

</td></tr>

18558

<tr><td align="left" valign="top"><a href="#it_005fyinyang">8.3.35 it_yinyang</a></td><td>  </td><td align="left" valign="top"> Player toggling Switch

18559

</td></tr>

18560

</table>

18561

18562

18563

18564

18565

18566

18567

18568

18569

18570

18571

18572

18573

18574

18575

18576

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

18577

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

18578

18579

</tr></table>

18580

18581

18582

18583

18584

A bag is a portable container for other objects. The player can fill it with

18585

up to 13 other items, including other empty or filled bags.

18586

18587

The bag allows a player to carry in total more than 13 items in his inventory.

18588

Nevertheless most items carried in a bag can not directly be applied. Just the

18589

<a href="#it_005fweight">it_weight</a> does apply its mass even when carried in a bag. On the other

18590

hand bags offer the user the possibility to pick up and drop items that can not

18591

be dropped otherwise as they would be activated. E.g. an <a href="#it_005fcherry">it_cherry</a> can

18592

not be dropped without application, but if it is contained in a bag the bag

18593

can be dropped and the cherry can be extracted later on. A bag is useful to

18594

transfer multiple items via <a href="#st_005fmail">st_mail</a>, too.

18595

18596

As long as an <code>it_bag</code> is at the first place in the inventory, new items

18597

are put into the bag instead of the inventory, until the bag is full (13 items).

18598

The player can drop an <code>it_bag</code> anytime. When picked up again, items from

18599

the bag are put back into the inventory (until it is full).

18600

18601

The quite complex rules of pick up in detail:

18602

18603

<ol>

18604

<li>

18605

Inventory and bag are limited concerning pickups to 13 items.

18606

18607

</li><li>

18608

Both are generally LIFO (last item picked up is first item out), but the

18609

inventory content can be rotated.

18610

18611

</li><li>

18612

If you pick up any item besides a bag and your first inventory item is not a bag

18613

the item is added to the inventory.

18614

18615

</li><li>

18616

If you pick up any item besides a non-empty bag and your first inventory item is

18617

a bag the item is added to the first inventory bag (this includes non-empty bags

18618

being added into first inventory bags!)

18619

18620

</li><li>

18621

You empty a bag by dropping it and picking it up again with any item at the

18622

first inventory position but a bag. As many items as possible are taken from the

18623

bag and added to the inventory.

18624

18625

</li><li>

18626

Empty bags are never put into other bags (this would cause unresolvable

18627

recursion problems). They will only be added as items directly to the inventory.

18628

18629

</li><li>

18630

If the "picked up" bag can not empty its contents to the inventory or a bag at

18631

the first inventory position is full the bag is not picked up and keeps the

18632

remaining items.

18633

18634

</li></ol>

18635

18636

You can add items directly to a bag by usage of the world <a href="#add">add</a> method.

18637

18638

Bags are used by <a href="#st_005fthief">st_thief</a> and <a href="#fl_005fthief">fl_thief</a> to carry their stolen

18639

items. When the thieves are captured by <a href="#st_005fchess">st_chess</a> the bag remains on the

18640

grid position filled up with the stolen items.

18641

18642

18643

<dt> Attributes:</dt>

18644

18645

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

18646

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

18647

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

18648

<dt> mass   values: positive float number;   default: <code>0.0</code>;   access: <code>read only</code></dt>

18649

<dd>Sum of masses of all contained items. Currently just the <a href="#it_005fweight">it_weight</a> has a

18650

mass.

18651

</dd>

18652

</dl>

18653

18654

</dd>

18655

<dt> Messages: none</dt>

18656

<dt> Variants:</dt>

18657

18658

<dt> <img src="images/it_bag.png" alt="images/it_bag"> it_bag

18659

</dt>

18660

</dl>

18661

</dd>

18662

</dl>

18663

18664

18665

18666

18667

18668

18669

18670

18671

18672

18673

18674

18675

18676

18677

18678

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

18679

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

18680

18681

</tr></table>

18682

18683

<h3 class="subsection">8.3.2 it_banana</h3>

18684

18685

18686

A portable item without direct usage. But it transforms into an <a href="#it_005fcherry">it_cherry</a>

18687

when hit by a laser beam.

18688

18689

When a stone is pushed over it an <a href="#it_005fsquashed">it_squashed</a> remains as remnants.

18690

18691

18692

<dt> Attributes:</dt>

18693

18694

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

18695

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

18696

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

18697

</dl>

18698

</dd>

18699

<dt> Messages: none</dt>

18700

<dt> Variants:</dt>

18701

18702

<dt> <img src="images/it_banana.png" alt="images/it_banana"> it_banana

18703

</dt>

18704

</dl>

18705

</dd>

18706

</dl>

18707

18708

18709

18710

18711

18712

18713

18714

18715

18716

18717

18718

18719

18720

18721

18722

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

18723

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

18724

18725

</tr></table>

18726

18727

<h3 class="subsection">8.3.3 it_bottle</h3>

18728

18729

18730

A bottle can be filled either with booze or with a message. When a bottle

18731

breaks the remnants are lethal sherds.

18732

18733

A bottle filled with booze makes any ball like actor that activates it drunken.

18734

The control of actor gets difficult as it will likely no longer move straight

18735

into the intended direction. Fortunately the period of drunkenness lasts just

18736

5 seconds per default. But you can set this time by the attribute

18737

‘<samp>interval</samp>’ to other values. The bottle will be dropped on activation.

18738

Activation of several bottles in sequence will lead to longer periods of

18739

drunkenness as the intervals will sum up.

18740

18741

Alternatively you can fill the bottle with a message by the attribute

18742

‘<samp>text</samp>’. Like <a href="#it_005fdocument">it_document</a> the message gets displayed on activation.

18743

Of course the actor does not get drunken in this case.

18744

18745

When a stone gets pushed over a bottle it will break to sherds. These

18746

remnants are lethal to <a href="#ac_005fmarble">ac_marble</a> and <a href="#ac_005fpearl">ac_pearl</a> when entering the

18747

affected grid. But of course they can jump over the broken bottle or pass it

18748

while being protected by an activated <a href="#it_005fumbrella">it_umbrella</a>. Unlike <a href="#it_005fdeath">it_death</a>

18749

the broken bottle can be removed by an actor by activation of an <a href="#it_005fbrush">it_brush</a>

18750

while jumping over it, or passing it with protection. But a broken bottle can

18751

not be picked up and is not portable.

18752

18753

18754

<dt> Attributes:</dt>

18755

18756

<dt> state,   values: <code>IDLE</code>, <code>BROKEN</code>;   default: <code>BROKEN</code>   See section <a href="#state">state</a></dt>

18757

<dt> interval   values: positive number;   default: <code>5.0</code></dt>

18758

<dd>Number of seconds that the actor becomes drunken.

18759

</dd>

18760

<dt> text,   values: string;</dt>

18761

<dd>Either the text to be displayed or just a key word for identification on

18762

<a href="#Internationalization-_0028i18n_0029">Internationalization (i18n)</a>.

18763

</dd>

18764

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

18765

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

18766

<dd>Just an ‘<samp>IDLE</samp>’ bottle is liftable, a ‘<samp>BROKEN</samp>’ one is not liftable.

18767

</dd>

18768

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

18769

<dd>Just an ‘<samp>IDLE</samp>’ bottle is portable, a ‘<samp>BROKEN</samp>’ one is not portable.

18770

</dd>

18771

</dl>

18772

18773

</dd>

18774

<dt> Messages: none</dt>

18775

<dt> Variants:</dt>

18776

18777

<dt> <img src="images/it_bottle_idle.png" alt="images/it_bottle_idle"> it_bottle: state = <code>IDLE</code>

18778

</dt>

18779

<dt> <img src="images/it_bottle_idle.png" alt="images/it_bottle_idle"> it_bottle_idle: state = <code>IDLE</code>

18780

</dt>

18781

<dt> <img src="images/it_bottle_broken.png" alt="images/it_bottle_broken"> it_bottle_broken: state = <code>BROKEN</code>

18782

</dt>

18783

</dl>

18784

18785

</dd>

18786

</dl>

18787

18788

18789

18790

18791

18792

18793

18794

18795

18796

18797

18798

18799

18800

18801

18802

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

18803

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

18804

18805

</tr></table>

18806

18807

<h3 class="subsection">8.3.4 it_brake</h3>

18808

18809

18810

The brake is a stone that can be picked up as an item by actors. The

18811

<a href="#st_005fbrake">st_brake</a> can be used to stop a running <a href="#st_005fboulder">st_boulder</a> or a

18812

<a href="#st_005flightpassenger">st_lightpassenger</a>, what likely has given this object its name.

18813

18814

When an actor passes below the brake stone it will pick up the object like

18815

other items. The brake will be added as a brake item to its inventory.

18816

Unlike other items the brake can be dropped even on grids that are already

18817

occupied by an item. But you can not drop the brake beneath another stone like

18818

a <a href="#it_005fseed">it_seed</a>.

18819

18820

On dropping the brake item it transforms immediately to an <a href="#st_005fbrake">st_brake</a> without

18821

killing an item positioned on the grid. The brake stone will press an

18822

<a href="#it_005ftrigger">it_trigger</a> beneath, what makes the brake item a portable trigger key.

18823

18824

The item itself will never exist on the world grid. It exists just as part of

18825

the player inventory or item containers like <a href="#it_005fbag">it_bag</a>.

18826

18827

Due to the <a href="#Snapshot-Principle">Snapshot Principle</a> you should never instantiate this item. Do

18828

set an <a href="#st_005fbrake">st_brake</a> to the world grid positions instead. This item is listed

18829

for your understanding what happens to a picked up brake and for identifying

18830

an <a href="#Object-Kind">Object Kind</a> ‘<samp>it_brake</samp>’ in an inventory or a container.

18831

18832

18833

<dt> Attributes:</dt>

18834

18835

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

18836

<dd>Even though being freezable a brake will never freeze as an item, as it is

18837

always converted to an <a href="#st_005fbrake">st_brake</a> on being dropped or placed onto a floor.

18838

</dd>

18839

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

18840

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

18841

</dl>

18842

</dd>

18843

<dt> Messages: none</dt>

18844

<dt> Variants:</dt>

18845

18846

<dt> <img src="images/st_brake.png" alt="images/st_brake"> it_brake

18847

</dt>

18848

</dl>

18849

18850

</dd>

18851

</dl>

18852

18853

18854

18855

18856

18857

18858

18859

18860

18861

18862

18863

18864

18865

18866

18867

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

18868

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

18869

18870

</tr></table>

18871

18872

<h3 class="subsection">8.3.5 it_brush</h3>

18873

18874

18875

A brush that is useful to paint some stones and sweep away some otherwise

18876

static items.

18877

18878

Stones must be hit with the brush revealed as the first item in the inventory.

18879

To sweep away nasty items the actor must activate the brush while being on the

18880

grid, or while jumping or flying over it:

18881

18882

<ul>

18883

<li> <a href="#st_005factorimpulse">st_actorimpulse</a>, invisible - makes invisible variant visible

18884

</li><li> <a href="#st_005fblur">st_blur</a>, magic - transforms to <a href="#st_005fpassage">st_passage</a>

18885

</li><li> <a href="#st_005fflat">st_flat</a>, burnable - transforms to <a href="#st_005fflat">st_flat</a>

18886

</li><li> <a href="#st_005fflat">st_flat</a>, moveburnable - transforms to <a href="#st_005fflat">st_flat</a>_movable

18887

</li><li> <a href="#st_005fghost">st_ghost</a>, purplemarble - transforms to <a href="#st_005fpurplemarble">st_purplemarble</a>

18888

</li><li> <a href="#st_005fghost">st_ghost</a>, break - transforms to <a href="#st_005fbreak">st_break</a>_oxydc

18889

</li><li> <a href="#st_005flightpassenger">st_lightpassenger</a>, off - reactivates to state ‘<samp>ON</samp>’

18890

</li><li> <a href="#it_005fbottle">it_bottle</a>, broken - remove from floor

18891

</li><li> <a href="#it_005fburnable">it_burnable</a>, ash - remove from floor

18892

</li><li> <a href="#it_005fburnable">it_burnable</a>, fireproof - remove from floor

18893

</li><li> <a href="#it_005fcross">it_cross</a> - remove from floor

18894

</li><li> <a href="#it_005fsquashed">it_squashed</a> - remove from floor

18895

</li></ul>

18896

18897

The brush is sensitive to laser light an dissolves with an <a href="#it_005fexplosion">it_explosion</a>_nil

18898

leaving no remnants when being hit by light.

18899

18900

18901

<dt> Attributes:</dt>

18902

18903

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

18904

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

18905

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

18906

</dl>

18907

</dd>

18908

<dt> Messages: none</dt>

18909

<dt> Variants:</dt>

18910

18911

<dt> <img src="images/it_brush.png" alt="images/it_brush"> it_brush

18912

</dt>

18913

</dl>

18914

18915

</dd>

18916

</dl>

18917

18918

18919

18920

18921

18922

18923

18924

18925

18926

18927

18928

18929

18930

18931

18932

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

18933

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

18934

18935

</tr></table>

18936

18937

<h3 class="subsection">8.3.6 it_cherry</h3>

18938

18939

18940

A magic item that makes the activating actor for 8 seconds invisible. But not

18941

all actors become invisible. Just the ball like actors <a href="#ac_005fmarble">ac_marble</a> and

18942

<a href="#ac_005fpearl">ac_pearl</a> do vanish.

18943

18944

An invisible actor can walk through most kinds of glass

18945

(see section <a href="#Transparent-Stones">Transparent Stones</a>) and as being invisible they do no longer attract

18946

hostile <a href="#ac_005frotor">ac_rotor</a> and <a href="#ac_005ftop">ac_top</a>.

18947

18948

When several cherries are activated in sequence each does prolong the actor’s

18949

time of invisibility by additional 8 seconds.

18950

18951

Other actors drop the cherry as an <a href="#it_005fsquashed">it_squashed</a> on activation. Sending a

18952

cherry via an <a href="#st_005fmail">st_mail</a> results in an <a href="#it_005fsquashed">it_squashed</a>, too. This

18953

gives you the control that a cherry added to one player’s inventory can not be

18954

easily transfered to other actors assigned to the other player. Just

18955

<a href="#st_005fthief">st_thief</a> and <a href="#fl_005fthief">fl_thief</a> are able to steal the cherry undamaged.

18956

18957

When a stone is pushed over a cherry an <a href="#it_005fsquashed">it_squashed</a> remains as remnants.

18958

18959

18960

<dt> Attributes:</dt>

18961

18962

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

18963

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

18964

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

18965

</dl>

18966

</dd>

18967

<dt> Messages: none</dt>

18968

<dt> Variants:</dt>

18969

18970

<dt> <img src="images/it_cherry.png" alt="images/it_cherry"> it_cherry

18971

</dt>

18972

</dl>

18973

</dd>

18974

</dl>

18975

18976

18977

18978

18979

18980

18981

18982

18983

18984

18985

18986

18987

18988

18989

18990

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

18991

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

18992

18993

</tr></table>

18994

18995

<h3 class="subsection">8.3.7 it_coffee</h3>

18996

18997

18998

A totally passive cup of coffee. It can be picked up and be dropped many times.

18999

It blocks laser light, prohibits <a href="#it_005fcrack">it_crack</a> spreading but it burns on fire

19000

and is blown away on <a href="#it_005fbomb">it_bomb</a> explosions.

19001

19002

19003

<dt> Attributes:</dt>

19004

19005

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

19006

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

19007

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

19008

</dl>

19009

</dd>

19010

<dt> Messages: none</dt>

19011

<dt> Variants:</dt>

19012

19013

<dt> <img src="images/it_coffee.png" alt="images/it_coffee"> it_coffee

19014

</dt>

19015

</dl>

19016

</dd>

19017

</dl>

19018

19019

19020

19021

19022

19023

19024

19025

19026

19027

19028

19029

19030

19031

19032

19033

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

19034

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

19035

19036

</tr></table>

19037

19038

19039

19040

19041

A coin activates an <a href="#st_005fcoinslot">st_coinslot</a> when inserted by hitting the stone with

19042

the coin as first item in the players inventory. The time interval of activity

19043

of the coinslot depends on the coin type that is represented by its

19044

‘<samp>state</samp>’. Small, medium and large coin variants do exist.

19045

19046

When hit by a moving stone the coin type changes from small to medium and

19047

from medium to large.

19048

19049

A laser beam transforms a small coin into an <a href="#it_005fumbrella">it_umbrella</a>, a medium coin

19050

into an <a href="#it_005fhammer">it_hammer</a> and a large coin into an <a href="#it_005fextralife">it_extralife</a>.

19051

19052

A coin that comes into existence on an illuminated grid position will not

19053

transform due to already existing laser beams. But it will transform on the first

19054

additional beam and on laser beams that are switched off and on again.

19055

19056

19057

<dt> Attributes:</dt>

19058

<dd>

19059

19060

<dt> state,   values: <code>SMALL</code>, <code>MEDIUM</code>, <code>LARGE</code>;   default: <code>SMALL</code>;   access: <code>read only</code>   See section <a href="#state">state</a></dt>

19061

<dd>Represents the coin type with ‘<samp>SMALL</samp>’ being a coin of 2 cents, ‘<samp>MEDIUM</samp>’

19062

being a coin of 5 cents and ‘<samp>LARGE</samp>’ being a coin of 10 cents..

19063

</dd>

19064

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

19065

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

19066

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

19067

</dl>

19068

19069

</dd>

19070

<dt> Messages: none</dt>

19071

<dt> Variants:</dt>

19072

19073

<dt> <img src="images/it_coin_s.png" alt="images/it_coin_s"> it_coin: state = <code>SMALL</code>

19074

</dt>

19075

<dt> <img src="images/it_coin_s.png" alt="images/it_coin_s"> it_coin_s: state = <code>SMALL</code>

19076

</dt>

19077

<dt> <img src="images/it_coin_m.png" alt="images/it_coin_m"> it_coin_m: state = <code>MEDIUM</code>

19078

</dt>

19079

<dt> <img src="images/it_coin_l.png" alt="images/it_coin_l"> it_coin_l: state = <code>LARGE</code>

19080

</dt>

19081

</dl>

19082

19083

</dd>

19084

</dl>

19085

19086

19087

19088

19089

19090

19091

19092

19093

19094

19095

19096

19097

19098

19099

19100

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

19101

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

19102

19103

</tr></table>

19104

19105

<h3 class="subsection">8.3.9 it_document</h3>

19106

19107

19108

This item looks like a piece of paper and contains a text message that can be

19109

displayed by activating the item. It is destroyed by explosions from

19110

<a href="#it_005fbomb">it_bomb</a>, <a href="#st_005fdispenser">st_dispenser</a>, <a href="#it_005fdynamite">it_dynamite</a> and by burning fire.

19111

The document is sensitive to laser light an dissolves with an

19112

<a href="#it_005fexplosion">it_explosion</a>_nil leaving no remnants when being hit by light.

19113

19114

Another message carrying item is the <a href="#it_005fbottle">it_bottle</a>.

19115

19116

19117

<dt> Attributes:</dt>

19118

19119

<dt> text,   values: string;</dt>

19120

<dd>Either the text to be displayed or just a key word for identification on

19121

<a href="#Internationalization-_0028i18n_0029">Internationalization (i18n)</a>.

19122

</dd>

19123

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

19124

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

19125

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

19126

</dl>

19127

19128

</dd>

19129

<dt> Messages:</dt>

19130

19131

<dt> ignite</dt>

19132

<dd>Burn and destroy the document.

19133

</dd>

19134

</dl>

19135

19136

</dd>

19137

<dt> Variants:</dt>

19138

19139

<dt> <img src="images/it_document.png" alt="images/it_document"> it_document

19140

</dt>

19141

</dl>

19142

</dd>

19143

</dl>

19144

19145

19146

19147

19148

19149

19150

19151

19152

19153

19154

19155

19156

19157

19158

19159

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

19160

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

19161

19162

</tr></table>

19163

19164

19165

19166

19167

The drop is a magic elixir for temporary actor transformations. On activation

19168

the actor transforms into another kind, lives for 5 seconds with all qualities

19169

of this kind and then transforms back to its old kind. The drop gets consumed

19170

by its activation. Generally it is not possible to prolong the transformation

19171

by activation of several drops.

19172

19173

Note that this object is currently just defined for the following actors:

19174

19175

<ul>

19176

<li> <a href="#ac_005fmarble">ac_marble</a> transforms to <a href="#ac_005frotor">ac_rotor</a>.

19177

</li></ul>

19178

19179

Providing a drop in a level with <a href="#ac_005fpearl">ac_pearl</a> will likely cause

19180

incompatibilities with future Enigma versions.

19181

19182

19183

<dt> Attributes:</dt>

19184

19185

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

19186

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

19187

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

19188

</dl>

19189

</dd>

19190

<dt> Messages: none</dt>

19191

<dt> Variants:</dt>

19192

19193

<dt> <img src="images/it_drop.png" alt="images/it_drop"> it_drop

19194

</dt>

19195

</dl>

19196

19197

</dd>

19198

</dl>

19199

19200

19201

19202

19203

19204

19205

19206

19207

19208

19209

19210

19211

19212

19213

19214

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

19215

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

19216

19217

</tr></table>

19218

19219

<h3 class="subsection">8.3.11 it_dynamite</h3>

19220

19221

19222

Dynamite is an explosive that can be picked up and that can be easily ignited

19223

at any free grid position. It ignites on drop, or if positioned on the floor in

19224

‘<samp>IDLE</samp>’ state it ignites on laser light, nearby fire and other nearby

19225

explosions as those caused by <a href="#it_005fbomb">it_bomb</a>, <a href="#st_005fdispenser">st_dispenser</a>, or other

19226

dynamite. A falling <a href="#ot_005fcannonball">ot_cannonball</a> lets it explode immediately without prior

19227

ignition.

19228

19229

On ignition its fuse starts burning. During this ‘<samp>ACTIVE</samp>’ state the

19230

dynamite can longer be picked up. After a short time the dynamite explodes

19231

causing on the 8 neighboring positions items to ignite and some stones like

19232

<a href="#st_005fbreak">st_break</a> to dissolve, too. The explosion leaves at its position an

19233

<a href="#it_005fmeditation">it_meditation</a>_hollow on all floor kinds besides <a href="#fl_005fice">fl_ice</a> where an

19234

<a href="#it_005fcrack">it_crack</a>_water remains.

19235

19236

Generally there is no direct way to stop a burning dynamite in order to prevent

19237

the explosion. It is even not allowed to reset the ‘<samp>state</samp>’ attribute to

19238

‘<samp>IDLE</samp>’. But when the user pushes an <a href="#st_005fice">st_ice</a> over a ‘<samp>ACTIVE</samp>’

19239

dynamite it will freeze and stop burning, returning to state ‘<samp>IDLE</samp>’.

19240

19241

Dynamite items will be added to the inventory when an actor hits a

19242

<a href="#st_005fdispenser">st_dispenser</a>_dynamite.

19243

19244

19245

<dt> Attributes:</dt>

19246

19247

<dt> state,   values: <code>IDLE</code>, <code>ACTIVE</code>;   default: <code>IDLE</code>   See section <a href="#state">state</a></dt>

19248

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

19249

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

19250

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

19251

<dd>Just ‘<samp>IDLE</samp>’ dynamite can be added to the inventory, burning ‘<samp>ACTIVE</samp>’

19252

ones are not portable.

19253

</dd>

19254

</dl>

19255

19256

</dd>

19257

<dt> Messages:</dt>

19258

19259

<dt> explode</dt>

19260

<dd>Direct explosion without burning fuse.

19261

</dd>

19262

<dt> ignite</dt>

19263

<dd>Ignite the fuse.

19264

</dd>

19265

19266

<dd>Ignite the fuse.

19267

</dd>

19268

</dl>

19269

19270

</dd>

19271

<dt> Variants:</dt>

19272

19273

<dt> <img src="images/it_dynamite.png" alt="images/it_dynamite"> it_dynamite: state = <code>IDLE</code>

19274

</dt>

19275

<dt> <img src="images/it_dynamite_burning.png" alt="images/it_dynamite_burning"> it_dynamite_burning: state = <code>ACTIVE</code>

19276

</dt>

19277

</dl>

19278

19279

</dd>

19280

</dl>

19281

19282

19283

19284

19285

19286

19287

19288

19289

19290

19291

19292

19293

19294

19295

19296

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

19297

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

19298

19299

</tr></table>

19300

19301

<h3 class="subsection">8.3.12 it_extinguisher</h3>

19302

19303

19304

A fire extinguisher that allows to extinguish burning fire and to protect areas

19305

with extinguishing foam of upcoming fire. See section <a href="#Fire-Spreading">Fire Spreading</a>.

19306

19307

A full loaded extinguisher allows two applications. The first one covers the

19308

nearest 13 grids, whereas the second one covers just 5 grids, the actor position

19309

itself and the 4 direct neighbor positions. The foam is an <a href="#it_005fburnable">it_burnable</a> of

19310

kind ‘<samp>fireproof</samp>’ which can be cleaned with an <a href="#it_005fbrush">it_brush</a> or by a

19311

<a href="#Flood-Spreading">Flood Spreading</a>.

19312

19313

The load is given by the attribute ‘<samp>state</samp>’ of the extinguisher and is

19314

visible for the user by a color spot. Green is a ‘<samp>FULL</samp>’ extinguisher,

19315

yellow a ‘<samp>MEDIUM</samp>’ filled extinguisher and red an ‘<samp>EMPTY</samp>’ extinguisher.

19316

19317

Extinguishers themselves are fireprotected as long as they are not empty.

19318

19319

The ‘<samp>toggle</samp>’ messages refills an extinguisher by one load until it is

19320

‘<samp>FULL</samp>’ again.

19321

19322

19323

<dt> Attributes:</dt>

19324

19325

<dt> state,   values: <code>EMPTY</code>, <code>MEDIUM</code>, <code>FULL</code>;   default: <code>FULL</code>   See section <a href="#state">state</a></dt>

19326

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

19327

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

19328

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

19329

</dl>

19330

19331

</dd>

19332

<dt> Messages:</dt>

19333

19334

<dt> toggle   See section <a href="#toggle">toggle</a></dt>

19335

<dd>A toggle causes a refill by one load.

19336

</dd>

19337

</dl>

19338

19339

</dd>

19340

<dt> Variants:</dt>

19341

19342

<dt> <img src="images/it_extinguisher.png" alt="images/it_extinguisher"> it_extinguisher: state = <code>FULL</code>

19343

</dt>

19344

<dt> <img src="images/it_extinguisher.png" alt="images/it_extinguisher"> it_extinguisher_full: state = <code>FULL</code>

19345

</dt>

19346

<dt> <img src="images/it_extinguisher_2.png" alt="images/it_extinguisher_2"> it_extinguisher_medium: state = <code>MEDIUM</code>

19347

</dt>

19348

<dt> <img src="images/it_extinguisher_3.png" alt="images/it_extinguisher_3"> it_extinguisher_empty: state = <code>EMPTY</code>

19349

</dt>

19350

</dl>

19351

19352

</dd>

19353

</dl>

19354

19355

19356

19357

19358

19359

19360

19361

19362

19363

19364

19365

19366

19367

19368

19369

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

19370

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

19371

19372

</tr></table>

19373

19374

<h3 class="subsection">8.3.13 it_extralife</h3>

19375

19376

19377

An extralife transforms into <a href="#it_005fglasses">it_glasses</a> when hit by a laser beam and is

19378

itself a laser transformation result of an ‘<samp>it_coin_l</samp>’ (see section <a href="#it_005fcoin">it_coin</a>).

19379

The global variable <a href="#ExtralifeGlasses">ExtralifeGlasses</a> describes what the new glasses are

19380

able to spot.

19381

19382

An extralife that comes into existence on an illuminated grid position will not

19383

be destroyed due to already existing laser beams. But it will be destroyed on

19384

the first additional beam and on laser beams that are switched off and on again.

19385

19386

If another item transforms into an extralife this new extralife will be immune to

19387

light destruction for a short latency period to avoid repeated item

19388

transformations.

19389

19390

19391

<dt> Attributes:</dt>

19392

19393

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

19394

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

19395

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

19396

</dl>

19397

19398

</dd>

19399

<dt> Variants:</dt>

19400

19401

<dt> <img src="images/it_extralife.png" alt="images/it_extralife"> it_extralife

19402

</dt>

19403

<dt> <img src="images/it_extralife.png" alt="images/it_extralife"> it_extralife_new: An extralife that is immune to light destruction for a short latency period.

19404

</dt>

19405

</dl>

19406

19407

</dd>

19408

</dl>

19409

19410

19411

19412

19413

19414

19415

19416

19417

19418

19419

19420

19421

19422

19423

19424

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

19425

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

19426

19427

</tr></table>

19428

19429

19430

19431

19432

Flags do mark the place where killed actors will be resurrected. Flags exist

19433

in two colors, ‘<samp>BLACK</samp>’ and ‘<samp>WHITE</samp>’. Each can be used to define the

19434

respawn position of matching colored <a href="#ac_005fmarble">ac_marble</a>s and <a href="#ac_005fpearl">ac_pearl</a>s.

19435

19436

As a level can contain many flags of the same ‘<samp>color</samp>’ the respawn position

19437

can not be defined by the flag position itself. The respawn position is the

19438

position of the last dropped flag of a given color. Additionally the respawn

19439

position gets cleared when after the last drop any flag of the same color gets

19440

picked up again. When no flag defined respawn position exists the actors will be

19441

resurrected at their initial position or the last secure position, if the global

19442

attribute <a href="#AutoRespawn">AutoRespawn</a> is set to <code>true</code>.

19443

19444

19445

<dt> Attributes:</dt>

19446

19447

<dt> color   values: <code>BLACK</code>, <code>WHITE</code>;   default: <code>BLACK</code></dt>

19448

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

19449

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

19450

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

19451

</dl>

19452

19453

</dd>

19454

<dt> Variants:</dt>

19455

19456

<dt> <img src="images/it_flag_black.png" alt="images/it_flag_black"> it_flag: color = <code>BLACK</code>

19457

</dt>

19458

<dt> <img src="images/it_flag_black.png" alt="images/it_flag_black"> it_flag_black: color = <code>BLACK</code>

19459

</dt>

19460

<dt> <img src="images/it_flag_white.png" alt="images/it_flag_white"> it_flag_white: color = <code>WHITE</code>

19461

</dt>

19462

</dl>

19463

</dd>

19464

</dl>

19465

19466

19467

19468

19469

19470

19471

19472

19473

19474

19475

19476

19477

19478

19479

19480

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

19481

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

19482

19483

</tr></table>

19484

19485

<h3 class="subsection">8.3.15 it_floppy</h3>

19486

19487

19488

A floppy activates an <a href="#st_005ffloppy">st_floppy</a> when inserted by hitting the stone with

19489

the floppy as first item in the players inventory.

19490

19491

19492

<dt> Attributes:</dt>

19493

19494

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

19495

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

19496

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

19497

</dl>

19498

</dd>

19499

<dt> Messages: none</dt>

19500

<dt> Variants:</dt>

19501

19502

<dt> <img src="images/it_floppy.png" alt="images/it_floppy"> it_floppy

19503

</dt>

19504

</dl>

19505

19506

</dd>

19507

</dl>

19508

19509

19510

19511

19512

19513

19514

19515

19516

19517

19518

19519

19520

19521

19522

19523

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

19524

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

19525

19526

</tr></table>

19527

19528

<h3 class="subsection">8.3.16 it_glasses</h3>

19529

19530

19531

Glasses help a marble to spot certain other objects that are otherwise invisible

19532

or indistinguishable.

19533

19534

To be effective glasses must be hold in the top level of a players inventory.

19535

That means that the glasses must be shown in the inventory and not be buried

19536

in an <a href="#it_005fbag">it_bag</a> that is part of the inventory. Of course glasses just help

19537

those actors that are attached to the player wearing the glasses.

19538

19539

Glasses can make invisible <a href="#st_005fdeath">st_death</a> visible, can uncover invisible

19540

passages by making hollow stones transparent, can make inactive

19541

<a href="#st_005flightpassenger">st_lightpassenger</a> be distinguishable from <a href="#st_005fdarkglass">st_darkglass</a>, can make

19542

invisible <a href="#it_005fsensor">it_sensor</a>, <a href="#it_005ftrap">it_trap</a> and <a href="#st_005factorimpulse">st_actorimpulse</a> be visible.

19543

19544

All these features are configurable by the constants ‘<samp>SPOT_DEATH</samp>’,

19545

‘<samp>SPOT_HOLLOW</samp>’, ‘<samp>SPOT_LIGHTPASSENGER</samp>’, ‘<samp>SPOT_SENSOR</samp>’,

19546

‘<samp>SPOT_TRAP</samp>’ and ‘<samp>SPOT_ACTORIMPULSE</samp>’. You can set the ‘<samp>state</samp>’

19547

attribute to a sum of these constants that should apply to given glasses. The

19548

default is for backward compatibility

19549

‘<samp>SPOT_DEATH + SPOT_HOLLOW + SPOT_LIGHTPASSENGER</samp>’. When a player wears

19550

several glasses he spots everything that any of the glasses could spot.

19551

19552

Glasses break when a stone is pushed over them. Broken glasses spot nothing.

19553

19554

Glasses result from the laser light transformation of <a href="#it_005fextralife">it_extralife</a>. The

19555

features of such new glasses are determined by the global variable

19556

<a href="#ExtralifeGlasses">ExtralifeGlasses</a>.

19557

19558

19559

<dt> Attributes:</dt>

19560

19561

<dt> state,   values: positive numbers;   default: <code>SPOT_DEATH + SPOT_HOLLOW + SPOT_LIGHTPASSENGER</code>   See section <a href="#state">state</a></dt>

19562

<dd>A sum of the constants ‘<samp>SPOT_DEATH</samp>’, ‘<samp>SPOT_HOLLOW</samp>’,

19563

‘<samp>SPOT_LIGHTPASSENGER</samp>’, ‘<samp>SPOT_SENSOR</samp>’, ‘<samp>SPOT_ACTORIMPULSE</samp>’,

19564

‘<samp>SPOT_TRAP</samp>’. ‘<samp>SPOT_NOTHING</samp>’ is the state of a broken glasses.

19565

</dd>

19566

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

19567

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

19568

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

19569

</dl>

19570

19571

</dd>

19572

<dt> Messages: none</dt>

19573

<dt> Variants:</dt>

19574

19575

<dt> <img src="images/it_glasses.png" alt="images/it_glasses"> it_glasses Active glasses item.

19576

</dt>

19577

<dt> <img src="images/it_glasses_broken.png" alt="images/it_glasses_broken"> it_glasses_broken Broken glasses that spot nothing.

19578

</dt>

19579

</dl>

19580

19581

</dd>

19582

</dl>

19583

19584

19585

19586

19587

19588

19589

19590

19591

19592

19593

19594

19595

19596

19597

19598

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

19599

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

19600

19601

</tr></table>

19602

19603

<h3 class="subsection">8.3.17 it_hammer</h3>

19604

19605

19606

The hammer is used to destroy some stones, see <a href="#Breakable-Stones">Breakable Stones</a> and

19607

<a href="#st_005flightpassenger">st_lightpassenger</a>.

19608

19609

It transforms into <a href="#it_005fsword">it_sword</a> when hit by a laser beam and is itself a

19610

laser transformation result of an <a href="#it_005fsword">it_sword</a> and an ‘<samp>it_coin_m</samp>’

19611

(see section <a href="#it_005fcoin">it_coin</a>).

19612

19613

An hammer that comes into existence on an illuminated grid position will not

19614

transform due to already existing laser beams. But it will transform on the first

19615

additional beam and on laser beams that are switched off and on again.

19616

19617

If another item transforms into an hammer this new hammer will be immune to

19618

further light transformations for a short latency period to avoid unstable

19619

flickering of repeated item transformations.

19620

19621

19622

<dt> Attributes:</dt>

19623

19624

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

19625

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

19626

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

19627

</dl>

19628

19629

</dd>

19630

<dt> Variants:</dt>

19631

19632

<dt> <img src="images/it_hammer.png" alt="images/it_hammer"> it_hammer A standard hammer item.

19633

</dt>

19634

<dt> <img src="images/it_hammer.png" alt="images/it_hammer"> it_hammer_new A hammer that is immune to light transformations for a short latency period.

19635

</dt>

19636

</dl>

19637

19638

</dd>

19639

</dl>

19640

19641

19642

19643

19644

19645

19646

19647

19648

19649

19650

19651

19652

19653

19654

19655

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

19656

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

19657

19658

</tr></table>

19659

19660

19661

19662

19663

A key activates an <a href="#st_005fkey">st_key</a> when inserted by hitting the stone with

19664

the key as first item in the players inventory.

19665

19666

Usually the ‘<samp>code</samp>’ of the key is not visually unveiled. But if you

19667

set ‘<samp>invisible</samp>’ to the value ‘<samp>false</samp>’ the code becomes visible for

19668

number code values ‘<samp>1</samp>’ to ‘<samp>8</samp>’. The code is just visible, when the

19669

key is part of the inventory. This helps the user to distinguish multiple keys

19670

in the inventory and to assign them to the matching <a href="#st_005fkey">st_key</a>s.

19671

19672

An ‘<samp>invisible</samp>’ key reveals its code when being inserted in a matching,

19673

unveiled <a href="#st_005fkey">st_key</a>. The code remains visible, when the user withdraws the

19674

key from the stone and adds it to his inventory.

19675

19676

19677

<dt> Attributes:</dt>

19678

19679

<dt> code,   values: number or string;   default: <code>1</code></dt>

19680

<dd>The code of a key must match that of an <a href="#st_005fkey">st_key</a> to unlock it.

19681

</dd>

19682

<dt> invisible   values: <code>true</code>, <code>false</code>;   default: <code>true</code></dt>

19683

<dd>A visible key unveils its ‘<samp>code</samp>’ by a color spot when being lifted.

19684

</dd>

19685

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

19686

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

19687

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

19688

</dl>

19689

19690

</dd>

19691

<dt> Messages: none</dt>

19692

<dt> Variants:</dt>

19693

19694

<dt> <img src="images/it_key.png" alt="images/it_key"> it_key

19695

</dt>

19696

</dl>

19697

</dd>

19698

</dl>

19699

19700

19701

19702

19703

19704

19705

19706

19707

19708

19709

19710

19711

19712

19713

19714

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

19715

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

19716

19717

</tr></table>

19718

19719

<h3 class="subsection">8.3.19 it_magicwand</h3>

19720

19721

19722

The wizard’s tool, that allows to do all sort of magic things if it is the

19723

wielded item in the player’s inventory:

19724

19725

<ul>

19726

<li> <a href="#st_005fblur">st_blur</a>, magic - transforms to <a href="#st_005fpassage">st_passage</a>,

19727

</li><li> <a href="#st_005fboulder">st_boulder</a> - changes orientation of a boulder,

19728

</li><li> <a href="#st_005fchess">st_chess</a> - changes the color of a chess stone,

19729

</li><li> <a href="#st_005fghost">st_ghost</a>, greenbrown - transforms to <a href="#st_005fgreenbrown">st_greenbrown</a>,

19730

</li><li> <a href="#st_005fmagic">st_magic</a>, brick - transforms to a <a href="#st_005frawglass">st_rawglass</a>,

19731

</li><li> <a href="#st_005foneway">st_oneway</a> - changes orientation of a oneway,

19732

</li><li> <a href="#st_005fpuzzle">st_puzzle</a> - scrambles blue puzzle stones instead of pushing, causes complete

19733

clusters to explode,

19734

</li><li> <a href="#st_005frubberband">st_rubberband</a> - makes rubberband stones movable,

19735

</li><li> <a href="#st_005fstoneimpulse">st_stoneimpulse</a>, movable - avoid pulsing on pushes.

19736

</li></ul>

19737

19738

19739

<dt> Attributes:</dt>

19740

19741

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

19742

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

19743

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

19744

</dl>

19745

19746

</dd>

19747

<dt> Messages: none</dt>

19748

<dt> Action: none</dt>

19749

<dt> Variants:</dt>

19750

19751

<dt> <img src="images/it_magicwand.png" alt="images/it_magicwand"> it_magicwand

19752

</dt>

19753

</dl>

19754

19755

</dd>

19756

</dl>

19757

19758

19759

19760

19761

19762

19763

19764

19765

19766

19767

19768

19769

19770

19771

19772

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

19773

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

19774

19775

</tr></table>

19776

19777

<h3 class="subsection">8.3.20 it_pencil</h3>

19778

19779

19780

An item to mark floors and stones.

19781

19782

An activated pencil scratches an <a href="#it_005fcross">it_cross</a> on most floors. As the pencil

19783

gets consumed by this operation the cross takes the pencils identity on

19784

this <a href="#Object-Transformation">Object Transformation</a>. But on <a href="#fl_005fice">fl_ice</a> the pencil makes a small

19785

<a href="#it_005fcrack">it_crack</a> as it is so sharp. On indestructible floors like <a href="#fl_005fabyss">fl_abyss</a>,

19786

<a href="#fl_005fwater">fl_water</a> and <a href="#fl_005fswamp">fl_swamp</a> and on <a href="#fl_005fbridge">fl_bridge</a> the pencil can not

19787

be activated at all. Any existing item on the floor does prevent a pencil

19788

application, too. The actor can only mark a floor if it is on the floor and not

19789

flying. During a jump an actor will just drop the pencil as an item.

19790

19791

On actor hits with a revealed pencil on a <a href="#st_005fflat">st_flat</a> the stones gets marked

19792

burnable. Again the pencil is consumed on this operation. Both the plain and

19793

the movable variants can be marked.

19794

19795

19796

<dt> Attributes:</dt>

19797

19798

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

19799

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

19800

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

19801

</dl>

19802

</dd>

19803

<dt> Messages: none</dt>

19804

<dt> Variants:</dt>

19805

19806

<dt> <img src="images/it_pencil.png" alt="images/it_pencil"> it_pencil

19807

</dt>

19808

</dl>

19809

19810

</dd>

19811

</dl>

19812

19813

19814

19815

19816

19817

19818

19819

19820

19821

19822

19823

19824

19825

19826

19827

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

19828

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

19829

19830

</tr></table>

19831

19832

19833

19834

19835

A pin is a friction increasing item that can be used as a crampon on <a href="#fl_005fice">fl_ice</a>.

19836

When it is picked up and is added to the inventory it significantly increases

19837

the floor friction applied to all actors owned by the inventory’s owner.

19838

19839

Pins do just increase friction as long as they are directly part of the

19840

inventory. A pin contained within an <a href="#it_005fbag">it_bag</a>, being part of the inventory,

19841

has no influence on the friction. Two or more pins do not apply more friction

19842

than a single pin. As soon as the last pin is dropped the friction returns

19843

to its standard values.

19844

19845

19846

<dt> Attributes:</dt>

19847

19848

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

19849

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

19850

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

19851

</dl>

19852

</dd>

19853

<dt> Messages: none</dt>

19854

<dt> Variants:</dt>

19855

19856

<dt> <img src="images/it_pin.png" alt="images/it_pin"> it_pin

19857

</dt>

19858

</dl>

19859

19860

</dd>

19861

</dl>

19862

19863

19864

19865

19866

19867

19868

19869

19870

19871

19872

19873

19874

19875

19876

19877

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

19878

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

19879

19880

</tr></table>

19881

19882

19883

19884

19885

Pipe items are used to build item transporting pipes connected to an

19886

<a href="#st_005fmail">st_mail</a>.

19887

19888

Pipe items are described by their ‘<samp>connections</samp>’ to neighbor grids. A pipe

19889

is build up of items with fitting connections.

19890

19891

Even though there exist pipe ending items with just one connection there is

19892

currently no known usage of them besides decoration.

19893

19894

19895

<dt> Attributes:</dt>

19896

19897

<dt> connections,   values: string;   default: <code>"ew"</code></dt>

19898

<dd>Describes the pipe connections to the neighbor grids. The string is a substring of

19899

<code>"nesw"</code> listing the existing connections. The sequence of the sides, north,

19900

east, south, west, is guaranteed on read access but arbitrary on write access.

19901

Currently only pipes with one or two connections do exist.

19902

</dd>

19903

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

19904

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

19905

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

19906

</dl>

19907

19908

</dd>

19909

<dt> Messages: none</dt>

19910

<dt> Action: none</dt>

19911

<dt> Variants:</dt>

19912

19913

<dt> <img src="images/it_pipe_e.png" alt="images/it_pipe_e"> it_pipe connections = <code>"ew"</code> The horizontal pipe.

19914

</dt>

19915

<dt> <img src="images/it_pipe_f.png" alt="images/it_pipe_f"> it_pipe_w connections = <code>"w"</code>

19916

</dt>

19917

<dt> <img src="images/it_pipe_b.png" alt="images/it_pipe_b"> it_pipe_s connections = <code>"s"</code>

19918

</dt>

19919

<dt> <img src="images/it_pipe_d.png" alt="images/it_pipe_d"> it_pipe_sw connections = <code>"sw"</code>

19920

</dt>

19921

<dt> <img src="images/it_pipe.png" alt="images/it_pipe"> it_pipe_e connections = <code>"e"</code>

19922

</dt>

19923

<dt> <img src="images/it_pipe_e.png" alt="images/it_pipe_e"> it_pipe_ew connections = <code>"ew"</code> The horizontal pipe.

19924

</dt>

19925

<dt> <img src="images/it_pipe_c.png" alt="images/it_pipe_c"> it_pipe_es connections = <code>"es"</code>

19926

</dt>

19927

<dt> <img src="images/it_pipe_g.png" alt="images/it_pipe_g"> it_pipe_n connections = <code>"n"</code>

19928

</dt>

19929

<dt> <img src="images/it_pipe_i.png" alt="images/it_pipe_i"> it_pipe_nw connections = <code>"nw"</code>

19930

</dt>

19931

<dt> <img src="images/it_pipe_j.png" alt="images/it_pipe_j"> it_pipe_ns connections = <code>"ns"</code> The vertical pipe.

19932

</dt>

19933

<dt> <img src="images/it_pipe_h.png" alt="images/it_pipe_h">it_pipe_ne connections = <code>"ne"</code>

19934

</dt>

19935

</dl>

19936

</dd>

19937

</dl>

19938

19939

19940

19941

19942

19943

19944

19945

19946

19947

19948

19949

19950

19951

19952

19953

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

19954

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

19955

19956

</tr></table>

19957

19958

<h3 class="subsection">8.3.23 it_puller</h3>

19959

19960

19961

A puller item looks like a white arrow. It can be picked up. But when being

19962

dropped it gets activated and whirls around. The actor should leave the grid

19963

immediately as the puller will finally dissolve in a lethal explosion.

19964

19965

But the main purpose of the puller is its ability to pull stones. The arrow

19966

‘<samp>orientation</samp>’ indicates the direction into which a stone will be pulled

19967

when the item is dropped in front. The pull takes place immediately at the end

19968

of the short explosion. It is a full blown stone pull, that will pull others

19969

stones connected to the directly affected stone via <a href="#ot_005fwire">ot_wire</a>, too. With

19970

the explosion the puller item ceases to exist.

19971

19972

19973

<dt> Attributes:</dt>

19974

19975

19976

</dd>

19977

<dt> orientation,   values: <code>NORTH</code>, <code>EAST</code>, <code>SOUTH</code>, <code>WEST</code>;   default: <code>WEST</code></dt>

19978

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

19979

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

19980

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

19981

</dl>

19982

19983

</dd>

19984

<dt> Messages: none</dt>

19985

<dt> Action: none</dt>

19986

<dt> Variants:</dt>

19987

19988

<dt> <img src="images/it_puller_4.png" alt="images/it_puller_4"> it_puller orientation = <code>WEST</code>

19989

</dt>

19990

<dt> <img src="images/it_puller_4.png" alt="images/it_puller_4"> it_puller_w orientation = <code>WEST</code>

19991

</dt>

19992

<dt> <img src="images/it_puller_3.png" alt="images/it_puller_3"> it_puller_s orientation = <code>SOUTH</code>

19993

</dt>

19994

<dt> <img src="images/it_puller_2.png" alt="images/it_puller_2"> it_puller_e orientation = <code>EAST</code>

19995

</dt>

19996

<dt> <img src="images/it_puller.png" alt="images/it_puller"> it_puller_n orientation = <code>NORTH</code>

19997

</dt>

19998

</dl>

19999

</dd>

20000

</dl>

20001

20002

20003

20004

20005

20006

20007

20008

20009

20010

20011

20012

20013

20014

20015

20016

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

20017

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

20018

20019

</tr></table>

20020

20021

20022

20023

20024

The ring is a magic position exchange item. On activation the ring gets dropped

20025

onto the grid and the actor gets warped either to the actors respawn position

20026

or to the position of another actor that is warped to the initiators position in

20027

exchange.

20028

20029

Note that this object is currently just defined in the following cases:

20030

20031

<ul>

20032

<li> just one arbitrary actor owned by player ‘<samp>YIN</samp>’ - the actor gets

20033

warped to its respawn position.

20034

</li><li> just an <a href="#ac_005fmarble">ac_marble</a>_black owned by player ‘<samp>YIN</samp>’ and an

20035

<a href="#ac_005fmarble">ac_marble</a>_white owned by player ‘<samp>YANG</samp>’ - both actors exchange their

20036

position.

20037

</li></ul>

20038

20039

Providing a ring in any other case will likely cause incompatibilities with

20040

future Enigma versions.

20041

20042

20043

<dt> Attributes:</dt>

20044

20045

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

20046

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

20047

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

20048

</dl>

20049

</dd>

20050

<dt> Messages: none</dt>

20051

<dt> Variants:</dt>

20052

20053

<dt> <img src="images/it_ring.png" alt="images/it_ring"> it_ring

20054

</dt>

20055

</dl>

20056

20057

</dd>

20058

</dl>

20059

20060

20061

20062

20063

20064

20065

20066

20067

20068

20069

20070

20071

20072

20073

20074

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

20075

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

20076

20077

</tr></table>

20078

20079

<h3 class="subsection">8.3.25 it_rubberband</h3>

20080

20081

20082

A portable <a href="#ot_005frubberband">ot_rubberband</a> that gets connected to the bearer on activation.

20083

20084

As the rubberband’s ‘<samp>anchor1</samp>’ is given by the activator itself, just the

20085

‘<samp>anchor2</samp>’ reference can be configured by this item. It can be any stone

20086

or actor reference.

20087

20088

Of special interest may be the usage of dynamic nearest object references

20089

(see section <a href="#Object-Naming">Object Naming</a>). A marble will be able to connect to the nearest

20090

object out of a given group.

20091

20092

If ‘<samp>anchor2</samp>’ does not exist, the ‘<samp>it_rubberband</samp>’ will be dropped.

20093

20094

The other attributes describe the force and length parameters of the

20095

<a href="#ot_005frubberband">ot_rubberband</a>, that will be created on application of the item. In fact

20096

the item’s identity will be transferred to its successor

20097

(see section <a href="#Object-Transformation">Object Transformation</a>). After creation of the life rubberband the

20098

action message will be send to the target. Note that it is actually the

20099

<a href="#ot_005frubberband">ot_rubberband</a> as the successor that sends the message.

20100

20101

20102

<dt> Attributes:</dt>

20103

<dd>

20104

20105

<dt> anchor2   values: actor or stone object;   default: <code>nil</code></dt>

20106

<dd>Object reference or name of an actor or a stone that the rubber will be

20107

connected to. The reference will be evaluated on item activation.

20108

</dd>

20109

<dt> strength   values: number;   default: <code>10.0</code></dt>

20110

<dd>The force strength.

20111

</dd>

20112

<dt> length   values: positive number or <code>AUTOLENGTH</code>;   default: <code>1.0</code></dt>

20113

<dd>The natural length above which forces are applied.

20114

</dd>

20115

<dt> threshold   values: positive number or zero;   default: <code>0.0</code></dt>

20116

<dd>The length smaller than the natural length below which inverted forces are applied.

20117

</dd>

20118

<dt> min   values: positive number or zero;   default: <code>0.0</code></dt>

20119

<dd>The minimum length at which actors bounce.

20120

</dd>

20121

<dt> max   values: positive number or zero;   default: <code>0.0</code></dt>

20122

<dd>The maximum length at which actors bounce.

20123

</dd>

20124

<dt> scissor   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

20125

<dd>Rubberband cutting behaviour on connection. On a value of <code>true</code> the

20126

activation of this rubberband will cut all existing rubberbands which are

20127

currently connected to the activating actor.

20128

</dd>

20129

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

20130

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

20131

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

20132

</dl>

20133

20134

</dd>

20135

<dt> Messages: none</dt>

20136

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

20137

<dd>On successful activation of this item the action message is send with a value of

20138

‘<samp>true</samp>’. Note that the parameter ‘<samp>sender</samp>’ will report the new

20139

<a href="#ot_005frubberband">ot_rubberband</a>.

20140

20141

</dd>

20142

<dt> Variants:</dt>

20143

20144

<dt> <img src="images/it_rubberband.png" alt="images/it_rubberband"> it_rubberband

20145

</dt>

20146

</dl>

20147

</dd>

20148

</dl>

20149

20150

20151

20152

20153

20154

20155

20156

20157

20158

20159

20160

20161

20162

20163

20164

20165

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

20166

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

20167

20168

</tr></table>

20169

20170

20171

20172

20173

Stone seeds are items that start growing and finally transforming to stones

20174

on activation. There are different ‘<samp>flavor</samp>’s of seeds that all look the

20175

same, but do grow to different stones. While a <code>"wood"</code> seed grows to an

20176

<a href="#st_005fbox">st_box</a>_wood, a <code>"hay"</code> seed grows to an <a href="#st_005fbox">st_box</a>_hay, a

20177

<code>"greenbrown"</code> seed grows to an unmovable <a href="#st_005fgreenbrown">st_greenbrown</a> and a

20178

<code>"volcano"</code> seed grows to an active <a href="#st_005fvolcano">st_volcano</a>.

20179

20180

Seeds can be dropped on any item free grid position, even beneath another stone

20181

that will get killed by the seed successor stone.

20182

20183

Seeds get automatically activated when being dropped, when hit by a laser beam

20184

or a stone being pushed on them. You can activate them by ‘<samp>grow</samp>’ and

20185

‘<samp>signal</samp>’ messages, too.

20186

20187

The identity of the seed gets transferred to the emerging stone including the

20188

attribute ‘<samp>secure</samp>’.

20189

20190

The only method of handling seeds without activation are containment within a

20191

<a href="#it_005fbag">it_bag</a> or sending them via <a href="#st_005fmail">st_mail</a> to a destination grid.

20192

20193

20194

<dt> Attributes:</dt>

20195

20196

<dt> flavor,   values: <code>"wood"</code>, <code>"hay"</code>, <code>"greenbrown"</code>, <code>"volcano"</code>;   default: <code>"wood"</code></dt>

20197

<dd>The type of the resulting stone.

20198

</dd>

20199

<dt> secure   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

20200

<dd>This attribute is transferred to the resulting stone. The <a href="#st_005fvolcano">st_volcano</a> and

20201

<a href="#st_005fbox">st_box</a> make use of it.

20202

</dd>

20203

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

20204

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

20205

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

20206

</dl>

20207

20208

</dd>

20209

<dt> Messages:</dt>

20210

20211

20212

<dd>Start growing the seed.

20213

</dd>

20214

<dt> signal   See section <a href="#signal">signal</a></dt>

20215

<dd>Start growing the seed.

20216

</dd>

20217

</dl>

20218

20219

</dd>

20220

<dt> Variants:</dt>

20221

20222

<dt> <img src="images/it_seed.png" alt="images/it_seed"> it_seed flavor = <code>"wood"</code>

20223

</dt>

20224

<dt> <img src="images/it_seed.png" alt="images/it_seed"> it_seed_wood flavor = <code>"wood"</code>

20225

</dt>

20226

<dt> <img src="images/it_seed.png" alt="images/it_seed"> it_seed_hay flavor = <code>"hay"</code>

20227

</dt>

20228

<dt> <img src="images/it_seed.png" alt="images/it_seed"> it_seed_greenbrown flavor = <code>"greenbrown"</code>

20229

</dt>

20230

<dt> <img src="images/it_seed.png" alt="images/it_seed"> it_seed_volcano flavor = <code>"volcano"</code>

20231

</dt>

20232

</dl>

20233

20234

</dd>

20235

</dl>

20236

20237

20238

20239

20240

20241

20242

20243

20244

20245

20246

20247

20248

20249

20250

20251

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

20252

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

20253

20254

</tr></table>

20255

20256

<h3 class="subsection">8.3.27 it_spade</h3>

20257

20258

20259

A spade activated while being on the grid position of an <a href="#it_005fmeditation">it_meditation</a>

20260

will flatten this by one degree and will finally eliminate it completely.

20261

20262

20263

<dt> Attributes:</dt>

20264

20265

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

20266

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

20267

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

20268

</dl>

20269

</dd>

20270

<dt> Messages: none</dt>

20271

<dt> Variants:</dt>

20272

20273

<dt> <img src="images/it_spade.png" alt="images/it_spade"> it_spade

20274

</dt>

20275

</dl>

20276

20277

</dd>

20278

</dl>

20279

20280

20281

20282

20283

20284

20285

20286

20287

20288

20289

20290

20291

20292

20293

20294

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

20295

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

20296

20297

</tr></table>

20298

20299

<h3 class="subsection">8.3.28 it_spoon</h3>

20300

20301

20302

Dropping a spoon is a medieval synonym for dying. The poor people had nothing

20303

besides a wooden spoon. They never dropped it. They had to peg out to give away

20304

their spoon.

20305

20306

Thus an Enigma spoon shatters the actor who drops it. When a player owns

20307

multiple actors just the active one gets killed. This is an essential difference

20308

to pressing F3, what shatters all actors of all players. When providing a spoon

20309

you may sometimes want to revoke the ability to commit a global suicide by

20310

pressing F3. You can do this by setting the global variable <a href="#AllowSuicide">AllowSuicide</a>

20311

to ‘<samp>false</samp>’.

20312

20313

20314

<dt> Attributes:</dt>

20315

20316

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

20317

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

20318

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

20319

</dl>

20320

</dd>

20321

<dt> Messages: none</dt>

20322

<dt> Variants:</dt>

20323

20324

<dt> <img src="images/it_spoon.png" alt="images/it_spoon"> it_spoon

20325

</dt>

20326

</dl>

20327

20328

</dd>

20329

</dl>

20330

20331

20332

20333

20334

20335

20336

20337

20338

20339

20340

20341

20342

20343

20344

20345

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

20346

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

20347

20348

</tr></table>

20349

20350

<h3 class="subsection">8.3.29 it_spring</h3>

20351

20352

20353

Springs let <a href="#Flying-Actors">Flying Actors</a> jump on activation.

20354

20355

There are two types of portable springs. A thin one that is kept in the

20356

inventory on activation and can thus be used multiple times in sequence. And

20357

a thick, condensed one that gets dropped on activation. A static jump

20358

facility that can not be picked up by an actor is the <a href="#it_005fspringboard">it_springboard</a>.

20359

20360

20361

<dt> Attributes:</dt>

20362

20363

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

20364

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

20365

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

20366

</dl>

20367

</dd>

20368

<dt> Messages: none</dt>

20369

<dt> Variants:</dt>

20370

20371

<dt> <img src="images/it_spring.png" alt="images/it_spring"> it_spring

20372

</dt>

20373

<dt> <img src="images/it_spring.png" alt="images/it_spring"> it_spring_keep

20374

</dt>

20375

<dt> <img src="images/it_spring_2.png" alt="images/it_spring_2"> it_spring_drop

20376

</dt>

20377

</dl>

20378

</dd>

20379

</dl>

20380

20381

20382

20383

20384

20385

20386

20387

20388

20389

20390

20391

20392

20393

20394

20395

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

20396

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

20397

20398

</tr></table>

20399

20400

<h3 class="subsection">8.3.30 it_surprise</h3>

20401

20402

20403

An item that transforms into a random item as soon as the player drops it.

20404

20405

The replacement item is a random one out of a given selection. You can set

20406

the ‘<samp>selection</samp>’ attribute with tokens of strings. Every string needs either

20407

to be an <a href="#Object-Kind">Object Kind</a> or a tile key prefixed by an equal sign ‘<samp>=</samp>’.

20408

20409

<table><tr><td> </td><td><pre class="example">ti["m"] = {"it_magicwand"}

20410

ti["e"] = {"it_extralife"}

20411

ti["s"] = {"it_surprise", selection={"it_seed", "=m", "=e", "=e"}}

20412

</pre></td></tr></table>

20413

20414

The replacement item is randomly chosen out of the given selection. By listing

20415

an item several times you can take influence on the likelihood.

20416

20417

The tile declarations referenced by a key may even contain objects besides

20418

items. But you should make rare and proper usage of this feature.

20419

20420

The surprise item will perform its action after being dropped but before

20421

being replaced. You can use this action to modify the selection or to

20422

set objects on your own.

20423

20424

The surprise item is killed by any replacement item set to the grid position.

20425

If your selection does not resolve to an item you may need to add ‘<samp>"it_nil"</samp>’

20426

to the replacement tile declaration.

20427

20428

20429

<dt> Attributes:</dt>

20430

20431

<dt> selection,   values: tokens of item kinds and tile keys;   default: <code>{"it_umbrella", "it_spring_keep", "it_dynamite", "it_coffee", "it_hammer"}</code></dt>

20432

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

20433

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

20434

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

20435

</dl>

20436

20437

</dd>

20438

<dt> Messages:</dt>

20439

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

20440

<dt> Variants:</dt>

20441

20442

<dt> <img src="images/it_surprise.png" alt="images/it_surprise"> it_surprise

20443

</dt>

20444

</dl>

20445

20446

</dd>

20447

</dl>

20448

20449

20450

20451

20452

20453

20454

20455

20456

20457

20458

20459

20460

20461

20462

20463

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

20464

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

20465

20466

</tr></table>

20467

20468

<h3 class="subsection">8.3.31 it_sword</h3>

20469

20470

20471

The sword is used to neutralize <a href="#st_005fknight">st_knight</a>.

20472

20473

It transforms into <a href="#it_005fhammer">it_hammer</a> when hit by a laser beam and is itself a

20474

laser transformation result of an <a href="#it_005fhammer">it_hammer</a>.

20475

20476

A sword that comes into existence on an illuminated grid position will not

20477

transform due to already existing laser beams. But it will transform on the first

20478

additional beam and on laser beams that are switched off and on again.

20479

20480

If another item transforms into a sword this new sword will be immune to

20481

further light transformations for a short latency period to avoid unstable

20482

flickering of repeated item transformations.

20483

20484

20485

<dt> Attributes:</dt>

20486

20487

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

20488

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

20489

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

20490

</dl>

20491

20492

</dd>

20493

<dt> Variants:</dt>

20494

20495

<dt> <img src="images/it_sword.png" alt="images/it_sword"> it_sword A standard sword item.

20496

</dt>

20497

<dt> <img src="images/it_sword.png" alt="images/it_sword"> it_sword_new A sword that is immune to light transformations for a short latency period.

20498

</dt>

20499

</dl>

20500

20501

</dd>

20502

</dl>

20503

20504

20505

20506

20507

20508

20509

20510

20511

20512

20513

20514

20515

20516

20517

20518

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

20519

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

20520

20521

</tr></table>

20522

20523

<h3 class="subsection">8.3.32 it_umbrella</h3>

20524

20525

20526

An activated umbrella temporarily protects a marble from <a href="#st_005fdeath">st_death</a>,

20527

<a href="#st_005fknight">st_knight</a>, <a href="#st_005fthief">st_thief</a>, <a href="#fl_005fabyss">fl_abyss</a>, <a href="#fl_005fwater">fl_water</a>,

20528

<a href="#fl_005fswamp">fl_swamp</a>, <a href="#fl_005fthief">fl_thief</a>, <a href="#it_005fdeath">it_death</a>, <a href="#it_005ftrap">it_trap</a>,

20529

broken <a href="#it_005fbottle">it_bottle</a>, explosions, moving stones and all other internal

20530

‘<samp>shatter</samp>’ and ‘<samp>fall</samp>’ events; in other words, from all lethal

20531

situations and thieves. The protection lasts for 10 seconds. Multiple umbrellas

20532

activated in sequence will prolong the protection period.

20533

20534

An umbrella gets destroyed when hit by a laser beam and is itself a

20535

laser transformation result of an ‘<samp>it_coin_s</samp>’(see section <a href="#it_005fcoin">it_coin</a>).

20536

20537

An umbrella that comes into existence on an illuminated grid position will not

20538

be destroyed due to already existing laser beams. But it will be destroyed on

20539

the first additional beam and on laser beams that are switched off and on again.

20540

20541

If another item transforms into an umbrella this new umbrella will be immune to

20542

light destruction for a short latency period to avoid repeated item

20543

transformations.

20544

20545

20546

<dt> Attributes:</dt>

20547

20548

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

20549

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

20550

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

20551

</dl>

20552

20553

</dd>

20554

<dt> Variants:</dt>

20555

20556

<dt> <img src="images/it_umbrella.png" alt="images/it_umbrella"> it_umbrella A standard umbrella item.

20557

</dt>

20558

<dt> <img src="images/it_umbrella.png" alt="images/it_umbrella"> it_umbrella_new An umbrella that is immune to light destruction for a short latency period.

20559

</dt>

20560

</dl>

20561

20562

</dd>

20563

</dl>

20564

20565

20566

20567

20568

20569

20570

20571

20572

20573

20574

20575

20576

20577

20578

20579

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

20580

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

20581

20582

</tr></table>

20583

20584

<h3 class="subsection">8.3.33 it_weight</h3>

20585

20586

20587

A weight is an item with a mass, that defaults to the mass of 10 <a href="#ac_005fmarble">ac_marble</a>s.

20588

When it is picked up it is added to the inventory and increases the mass of

20589

all actors owned by the inventory’s owner.

20590

20591

Weights can easily be picked up, but the player can not drop them. Just indirect

20592

methods like hitting <a href="#st_005fmail">st_mail</a>, <a href="#st_005fthief">st_thief</a> or crossing a <a href="#fl_005fthief">fl_thief</a>

20593

may remove this item from the inventory.

20594

20595

The inventories mass is always updated to the mass of all weights kept in the

20596

inventory or contained in any <a href="#it_005fbag">it_bag</a> contained in the inventory.

20597

20598

20599

<dt> Attributes: none</dt>

20600

20601

<dt> mass   values: positive float number;   default: <code>+10.0</code></dt>

20602

<dd>Mass unit is the mass of an <a href="#ac_005fmarble">ac_marble</a>

20603

</dd>

20604

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

20605

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

20606

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

20607

</dl>

20608

20609

</dd>

20610

<dt> Messages: none</dt>

20611

<dt> Variants:</dt>

20612

20613

<dt> <img src="images/it_weight.png" alt="images/it_weight"> it_weight

20614

</dt>

20615

</dl>

20616

20617

</dd>

20618

</dl>

20619

20620

20621

20622

20623

20624

20625

20626

20627

20628

20629

20630

20631

20632

20633

20634

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

20635

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

20636

20637

</tr></table>

20638

20639

<h3 class="subsection">8.3.34 it_wrench</h3>

20640

20641

20642

A wrench wielded as first item in the players inventory causes some objects

20643

to react on actor hits. An <a href="#st_005frotator">st_rotator</a> changes its turning direction.

20644

A green <a href="#st_005fturnstile">st_turnstile</a> rotates backwards when hit. An <a href="#st_005fwindow">st_window</a>

20645

face pushed with an wrench will swap to the opposite side of the stone if

20646

possible.

20647

20648

20649

<dt> Attributes:</dt>

20650

20651

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

20652

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

20653

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

20654

</dl>

20655

</dd>

20656

<dt> Messages: none</dt>

20657

<dt> Variants:</dt>

20658

20659

<dt> <img src="images/it_wrench.png" alt="images/it_wrench"> it_wrench

20660

</dt>

20661

</dl>

20662

20663

</dd>

20664

</dl>

20665

20666

20667

20668

20669

20670

20671

20672

20673

20674

20675

20676

20677

20678

20679

20680

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

20681

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

20682

20683

</tr></table>

20684

20685

<h3 class="subsection">8.3.35 it_yinyang</h3>

20686

20687

20688

A special switch that allows the user to toggle the <a href="#Player-and-Inventory">Player and Inventory</a>

20689

between <code>YIN</code> and <code>YANG</code>.

20690

20691

On activation this item does not get dropped but remains unchanged in the

20692

inventory.

20693

20694

If a level has been declared to be a full blown two player network level in

20695

<a href="#g_t_003cmodes_003e"><modes></a>, but is currently played on a single computer both players

20696

get automatically an yinyang item added to their inventory to allow all actors

20697

to be controlled at every point of time.

20698

20699

20700

<dt> Attributes:</dt>

20701

20702

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

20703

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

20704

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

20705

</dl>

20706

</dd>

20707

<dt> Messages: none</dt>

20708

<dt> Variants:</dt>

20709

20710

<dt> <img src="images/it_yinyang.png" alt="images/it_yinyang"> it_yinyang

20711

</dt>

20712

</dl>

20713

20714

</dd>

20715

</dl>

20716

20717

20718

20719

20720

20721

20722

20723

20724

20725

20726

20727

20728

20729

20730

20731

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

20732

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

20733

20734

</tr></table>

20735

20736

<h2 class="section">8.4 Static Items</h2>

20737

20738

20739

<tr><td align="left" valign="top"><a href="#it_005fblocker">8.4.1 it_blocker</a></td><td>  </td><td align="left" valign="top"> Shrinked Blocker Stone

20740

</td></tr>

20741

<tr><td align="left" valign="top"><a href="#it_005fbomb">8.4.2 it_bomb</a></td><td>  </td><td align="left" valign="top"> Big Explosive Charge

20742

</td></tr>

20743

<tr><td align="left" valign="top"><a href="#it_005fburnable">8.4.3 it_burnable</a></td><td>  </td><td align="left" valign="top"> Fire State

20744

</td></tr>

20745

<tr><td align="left" valign="top"><a href="#it_005fcrack">8.4.4 it_crack</a></td><td>  </td><td align="left" valign="top"> Crack in the Floor

20746

</td></tr>

20747

<tr><td align="left" valign="top"><a href="#it_005fcross">8.4.5 it_cross</a></td><td>  </td><td align="left" valign="top"> Floor Switch for patient Actors

20748

</td></tr>

20749

<tr><td align="left" valign="top"><a href="#it_005fdeath">8.4.6 it_death</a></td><td>  </td><td align="left" valign="top"> Impassable grid blocker

20750

</td></tr>

20751

<tr><td align="left" valign="top"><a href="#it_005fexplosion">8.4.7 it_explosion</a></td><td>  </td><td align="left" valign="top"> Short Explosion Animation

20752

</td></tr>

20753

<tr><td align="left" valign="top"><a href="#it_005flandmine">8.4.8 it_landmine</a></td><td>  </td><td align="left" valign="top"> Buried Explosive

20754

</td></tr>

20755

<tr><td align="left" valign="top"><a href="#it_005flaserbeam">8.4.9 it_laserbeam</a></td><td>  </td><td align="left" valign="top"> Laser Beam

20756

</td></tr>

20757

<tr><td align="left" valign="top"><a href="#it_005fmagnet">8.4.10 it_magnet</a></td><td>  </td><td align="left" valign="top"> Actor attracting Magnet

20758

</td></tr>

20759

<tr><td align="left" valign="top"><a href="#it_005fmeditation">8.4.11 it_meditation</a></td><td>  </td><td align="left" valign="top"> Hills and Hollows

20760

</td></tr>

20761

<tr><td align="left" valign="top"><a href="#it_005fsensor">8.4.12 it_sensor</a></td><td>  </td><td align="left" valign="top"> Floor Switch for passing Actors

20762

</td></tr>

20763

<tr><td align="left" valign="top"><a href="#it_005fshogun">8.4.13 it_shogun</a></td><td>  </td><td align="left" valign="top"> Dot for Shogun Stones

20764

</td></tr>

20765

<tr><td align="left" valign="top"><a href="#it_005fspringboard">8.4.14 it_springboard</a></td><td>  </td><td align="left" valign="top"> Static Spring

20766

</td></tr>

20767

<tr><td align="left" valign="top"><a href="#it_005fsquashed">8.4.15 it_squashed</a></td><td>  </td><td align="left" valign="top"> Remnant of squashed Fruits

20768

</td></tr>

20769

<tr><td align="left" valign="top"><a href="#it_005fstrip">8.4.16 it_strip</a></td><td>  </td><td align="left" valign="top"> Narrow Bridge

20770

</td></tr>

20771

<tr><td align="left" valign="top"><a href="#it_005ftrap">8.4.17 it_trap</a></td><td>  </td><td align="left" valign="top"> Invisible, covered Abyss

20772

</td></tr>

20773

<tr><td align="left" valign="top"><a href="#it_005ftrigger">8.4.18 it_trigger</a></td><td>  </td><td align="left" valign="top"> Floor Switch for Actors and Stones

20774

</td></tr>

20775

<tr><td align="left" valign="top"><a href="#it_005fvortex">8.4.19 it_vortex</a></td><td>  </td><td align="left" valign="top"> Teleport of Marbles

20776

</td></tr>

20777

<tr><td align="left" valign="top"><a href="#it_005fwormhole">8.4.20 it_wormhole</a></td><td>  </td><td align="left" valign="top"> Teleport of Actors

20778

</td></tr>

20779

</table>

20780

20781

20782

20783

20784

20785

20786

20787

20788

20789

20790

20791

20792

20793

20794

20795

20796

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

20797

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

20798

20799

</tr></table>

20800

20801

<h3 class="subsection">8.4.1 it_blocker</h3>

20802

20803

20804

A door like object that grows to <a href="#st_005fblocker">st_blocker</a> when an <a href="#st_005fboulder">st_boulder</a>

20805

passes. When the boulder did shrink and pass the blocker again it stays in its

20806

item like open state until it is passed again by a boulder which causes it to

20807

grow again to a blocker stone.

20808

20809

It fully supports the messages of any door like object and can be opened and

20810

closed by any switch like object. Note that due to the transformation between

20811

stone and item during opening and closing you should name the blocker

20812

(see section <a href="#name">name</a>) and address the blocker by this name. The complete identity

20813

with all attributes including any user attributes will be transferred between

20814

stone and item. E.g. <code>{it_switch, target="myblocker", action="toggle"}</code>

20815

will open and close a given blocker multiple times.

20816

20817

Note that the blocker is the only door object that allows a stone to be pushed

20818

through. Just boulders cause the growing. Any other stone keeps the open state.

20819

20820

Another unique door feature is the closing of a blocker item caused by a

20821

passing actor if the autoclose attribute is set to true.

20822

20823

Note that a dropped <a href="#it_005fbrake">it_brake</a> destroys this item.

20824

20825

20826

<dt> Attributes:</dt>

20827

<dd>

20828

20829

<dt> state,   values: <code>0</code>, <code>1</code>;   default: <code>1</code>   See section <a href="#state">state</a></dt>

20830

<dd>Use CLOSED and OPEN macros as values. The item represents the open state

20831

and will always return state 1. But you can set its state what is equivalent

20832

to sending an open message in case of value 1 and a close message in case of

20833

value 0.

20834

20835

20836

</dd>

20837

<dt> autoclose   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

20838

<dd>A true value causes any actor passing this item to close and grow the blocker.

20839

20840

</dd>

20841

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

20842

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

20843

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

20844

</dl>

20845

20846

</dd>

20847

<dt> Messages:</dt>

20848

<dd>

20849

20850

<dt> signal   See section <a href="#signal">signal</a></dt>

20851

<dd>A signal of value 1 sends an open message, a signal of value 0 sends a close

20852

message.

20853

</dd>

20854

<dt> toggle   See section <a href="#toggle">toggle</a></dt>

20855

<dd>A toggle causes a close message.

20856

</dd>

20857

<dt> close   See section <a href="#close">close</a></dt>

20858

<dd>A close message take immediate effect if the item is not covered by a stone.

20859

The item transforms to a new growing <a href="#st_005fblocker">st_blocker</a>. If it is covered by a

20860

stone of whatever kind it will be marked as unlocked. The closing process starts

20861

when the stone moves away.

20862

</dd>

20863

<dt> open   See section <a href="#open">open</a></dt>

20864

<dd>As the item is open this message takes only effect if it is currently covered

20865

by a stone and marked as unlocked. That means it should grow as soon as the

20866

stone moves away what happens when an <a href="#st_005fboulder">st_boulder</a> passes an idle blocker

20867

item. In this case an open message locks the blocker again to avoid a growing

20868

when the stone moves away.

20869

</dd>

20870

</dl>

20871

20872

</dd>

20873

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

20874

<dd>Sends an action at the moment the blocker reaches the open state. That means

20875

an <a href="#st_005fblocker">st_blocker</a> did open and did generate this blocker item as its

20876

successor. The value will be <code>true</code> to express the open state.

20877

20878

</dd>

20879

<dt> Variants:</dt>

20880

20881

<dt> <img src="images/st_blocker_4.png" alt="images/st_blocker_4"> it_blocker

20882

</dt>

20883

<dd>A standard blocker item.

20884

</dd>

20885

<dt> <img src="images/st_blocker_4.png" alt="images/st_blocker_4"> it_blocker_new

20886

</dt>

20887

<dd>A blocker that just finished shrinking. Mainly used internally as the direct

20888

successor of an <a href="#st_005fblocker">st_blocker</a>. But it may be useful to generate an initial

20889

snapshot of a moving boulder over a blocker line, too. See example levels.

20890

</dd>

20891

</dl>

20892

20893

</dd>

20894

</dl>

20895

20896

20897

20898

20899

20900

20901

20902

20903

20904

20905

20906

20907

20908

20909

20910

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

20911

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

20912

20913

</tr></table>

20914

20915

20916

20917

20918

A bomb is an explosive that can not be picked up. It ignites on laser light,

20919

nearby fire and other nearby explosions as those caused by other <a href="#it_005fbomb">it_bomb</a>s,

20920

<a href="#it_005fdynamite">it_dynamite</a>, <a href="#st_005fdispenser">st_dispenser</a> exploding directly above a bomb, or simply

20921

by a solid stone being pushed over them (just a few stones like <a href="#st_005fshogun">st_shogun</a>,

20922

<a href="#st_005fbox">st_box</a>_hay do not cause bombs to ignite). A falling <a href="#ot_005fcannonball">ot_cannonball</a>

20923

lets it explode immediately without prior ignition.

20924

20925

On ignition its fuse starts burning. After a short time the bomb explodes

20926

causing on the 8 neighboring positions items to ignite and some stones like

20927

<a href="#st_005fbreak">st_break</a> to dissolve, too.

20928

20929

‘<samp>BLACK</samp>’ bombs will cause destructible items on the 4 neighboring positions

20930

to be blown away, and dissolves the floor beneath to a <a href="#fl_005fabyss">fl_abyss</a>.

20931

20932

‘<samp>WHITE</samp>’ bombs will cause destructible items on the 8 neighboring positions

20933

to be blown away, and dissolves the floor beneath and the 8 neighboring

20934

positions to <a href="#fl_005fabyss">fl_abyss</a>.

20935

20936

Bomb items will be added to the inventory when an actor hits a

20937

<a href="#st_005fdispenser">st_dispenser</a>_bombblack or <a href="#st_005fdispenser">st_dispenser</a>_bombwhite.

20938

20939

20940

<dt> Attributes:</dt>

20941

20942

<dt> state,   values: <code>IDLE</code>, <code>ACTIVE</code>;   default: <code>IDLE</code>   See section <a href="#state">state</a></dt>

20943

<dt> color   values: <code>BLACK</code>, <code>WHITE</code>;   default: <code>BLACK</code></dt>

20944

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

20945

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

20946

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

20947

<dd>Just bombs in ‘<samp>state</samp>’ ‘<samp>IDLE</samp>’ are portable, burning ‘<samp>ACTIVE</samp>’ ones

20948

can not be added to the inventory or an <a href="#it_005fbag">it_bag</a>.

20949

</dd>

20950

</dl>

20951

20952

</dd>

20953

<dt> Messages:</dt>

20954

20955

<dt> explode</dt>

20956

<dd>Direct explosion without burning fuse.

20957

</dd>

20958

<dt> ignite</dt>

20959

<dd>Ignite the fuse.

20960

</dd>

20961

20962

<dd>Ignite the fuse.

20963

</dd>

20964

</dl>

20965

20966

</dd>

20967

<dt> Variants:</dt>

20968

20969

<dt> <img src="images/it_bomb.png" alt="images/it_bomb"> it_bomb: color = <code>BLACK</code>

20970

</dt>

20971

<dt> <img src="images/it_bomb.png" alt="images/it_bomb"> it_bomb_black: color = <code>BLACK</code>

20972

</dt>

20973

<dt> <img src="images/it_bomb_b.png" alt="images/it_bomb_b"> it_bomb_white: color = <code>WHITE</code>

20974

</dt>

20975

</dl>

20976

20977

</dd>

20978

</dl>

20979

20980

20981

20982

20983

20984

20985

20986

20987

20988

20989

20990

20991

20992

20993

20994

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

20995

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

20996

20997

</tr></table>

20998

20999

<h3 class="subsection">8.4.3 it_burnable</h3>

21000

21001

21002

A legacy item representing the fire state and handling the visible animation.

21003

This item is nowadays mainly an internal system item as the <a href="#Fire-Spreading">Fire Spreading</a>

21004

with its attributes and messages is mainly handled by the <a href="#Floor-Objects">Floor Objects</a>.

21005

But it may be essential for your understanding to be aware of this object in

21006

all its variants. You may also need to make use of all variants on level

21007

initialization due to the <a href="#Snapshot-Principle">Snapshot Principle</a>.

21008

21009

The following variants do exist:

21010

<ul>

21011

<li> ‘<samp>invisible</samp>’ - allow a floor tile to catch fire, and to ignite on

21012

explosions; set the attributes <a href="#burnable">burnable</a> and <a href="#ignitable">ignitable</a> on the floor

21013

instead.

21014

</li><li> ‘<samp>oil</samp>’ - is the visible variant of the invisible burnable item.

21015

</li><li> ‘<samp>ignited</samp>’ - carries the starting-animation of fire; send the

21016

‘<samp>setfire</samp>’ message to a floor or set the floor with attribute

21017

‘<samp>initfire</samp>’ instead.

21018

</li><li> ‘<samp>burning</samp>’ - carries the animation of burning fire. Use setfire instead.

21019

</li><li> ‘<samp>ash</samp>’ - the unburnable remnant of a fire.

21020

</li><li> ‘<samp>fireproof</samp>’ - the extinguisher foam that protects from fire.

21021

</li></ul>

21022

21023

Note that you are not allowed to set or change the ‘<samp>state</samp>’ of a burnable

21024

item. But you can investigate the kind of a burnable.

21025

21026

Besides by <a href="#Fire-Spreading">Fire Spreading</a> the user can interact with burnable items with

21027

the following other objects:

21028

<ul>

21029

<li> <a href="#it_005fextinguisher">it_extinguisher</a> sprays ‘<samp>fireproof</samp>’ foam

21030

</li><li> <a href="#it_005fbrush">it_brush</a> removes ‘<samp>ash</samp>’ and ‘<samp>fireproof</samp>’

21031

</li><li> <a href="#st_005fice">st_ice</a> removes all burnable besides ‘<samp>oil</samp>’ when being pushed over them

21032

</li></ul>

21033

21034

21035

<dt> Attributes:</dt>

21036

21037

<dt> state,   values: integer numbers between 0 and 5;   default: <code>0</code>;   access: <code>read only</code>   See section <a href="#state">state</a></dt>

21038

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

21039

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

21040

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

21041

</dl>

21042

21043

</dd>

21044

<dt> Messages:</dt>

21045

21046

<dt> ignite   See section <a href="#ignite">ignite</a></dt>

21047

<dd>Ignites the floor beneath.

21048

</dd>

21049

<dt> extinguish</dt>

21050

<dd>Changes burnable immediately to extinguisher foam.

21051

</dd>

21052

</dl>

21053

21054

</dd>

21055

<dt> Variants:</dt>

21056

21057

<dt> <img src="images/fl_white.png" alt="images/fl_white"> it_burnable: state = <code>0</code>

21058

</dt>

21059

<dt> <img src="images/fl_white.png" alt="images/fl_white"> it_burnable_invisible: state = <code>0</code>

21060

</dt>

21061

<dt> <img src="images/it_burnable_oil.png" alt="images/it_burnable_oil"> it_burnable_oil: state = <code>1</code>

21062

</dt>

21063

<dt> <img src="images/fl_white.png" alt="images/fl_white"> it_burnable_ignited: state = <code>2</code>

21064

</dt>

21065

<dt> <img src="images/it_burnable_burning.png" alt="images/it_burnable_burning"> it_burnable_burning: state = <code>3</code>

21066

</dt>

21067

<dt> <img src="images/it_burnable_ash.png" alt="images/it_burnable_ash"> it_burnable_ash: state = <code>4</code>

21068

</dt>

21069

<dt> <img src="images/it_burnable_fireproof.png" alt="images/it_burnable_fireproof"> it_burnable_fireproof: state = <code>5</code>

21070

</dt>

21071

</dl>

21072

21073

</dd>

21074

</dl>

21075

21076

21077

21078

21079

21080

21081

21082

21083

21084

21085

21086

21087

21088

21089

21090

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

21091

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

21092

21093

</tr></table>

21094

21095

<h3 class="subsection">8.4.4 it_crack</h3>

21096

21097

21098

A legacy item that features a crack in the floor. A crack increases every time

21099

an actor enters and finally dissolves the floor either into an <a href="#fl_005fabyss">fl_abyss</a>

21100

or an <a href="#fl_005fwater">fl_water</a>. The color of the fissures shows the upcoming new floor

21101

kind and corresponds to the attribute ‘<samp>flavor</samp>’.

21102

21103

The progress of the floor destruction is described by the attribute ‘<samp>state</samp>’.

21104

On every crack event the state advances by one and a cracking ‘<samp>LARGE</samp>’ crack

21105

finally dissolves giving an actor on top just enough time to leave the grid at

21106

once. Of course an actor jumping over a crack does not causes change on the

21107

crack itself.

21108

21109

You can control the crack progress by the two attributes ‘<samp>spreading</samp>’ and

21110

‘<samp>fragility</samp>’. Where as the first attribute describes the likelihood that the

21111

crack spreads to a neighboring crack free grid, does the second attribute

21112

describe the likelihood that an existing crack advances its state.

21113

21114

An actor entering a crack causes the crack itself to advance its state with the

21115

given likelihood. A default ‘<samp>abyss</samp>’ crack causes existing cracks on any of

21116

the 4 neighboring grid positions to advance their states, too. But a

21117

‘<samp>water</samp>’ crack does not advance neighboring cracks. Both do cause a spread

21118

with the given likelihood of an invisible crack to any of the 4 neighboring grid

21119

positions in case no crack or any other items exists on it.

21120

21121

Let us have another look on a spreading crack. An actor entering a crack causes

21122

an invisible crack on the next grid. If the actor continues to move to this grid

21123

the invisible crack advances to a small visible one, of cause just with the

21124

given likelihood. Note that this first and just this first crack progress takes

21125

place with the likelihood of spreading, too. That means even if the fragility is

21126

zero the invisible crack gets visible.

21127

21128

Another special feature is the behaviour of a large crack. An actor entering

21129

causes it to dissolve. But this causes neither a spreading nor a crack advancing

21130

on neighboring grids. This feature is essential to allow an actor to walk over

21131

a path of large cracks, as the next grid may not dissolve on an actor entering

21132

the one before.

21133

21134

Common attribute patterns besides the default ones are:

21135

<ul>

21136

<li> ‘<samp>spreading=0, fragility=0</samp>’ - a fake crack that neither spreads nor dissolves

21137

</li><li> ‘<samp>spreading=0, fragility=1</samp>’ - a crack that dissolves and causes neighbor cracks to dissolve, but does not spread to new floors

21138

</li></ul>

21139

21140

Both attributes are inherited to new cracks during the process of spreading.

21141

If not set they take as default the value of the global attributes. For a maximum

21142

control you can set individual floors their own <a href="#fragility-_0028floor_0029">fragility (floor)</a>. These

21143

values supersede the global <a href="#Fragility">Fragility</a> default.

21144

21145

Indestructible floors like <a href="#fl_005fabyss">fl_abyss</a>, <a href="#fl_005fwater">fl_water</a>, <a href="#fl_005fswamp">fl_swamp</a> will

21146

never crack. As any other item cracks do block laser light and prohibit other items to be

21147

dropped on the same grid. Nearby fire, explosions and hitting

21148

<a href="#ot_005fcannonball">ot_cannonball</a>s will dissolve a crack by another step.

21149

21150

On the other hand <a href="#st_005fice">st_ice</a> will putty any existing crack when being pushed

21151

over it.

21152

21153

21154

<dt> Attributes:</dt>

21155

<dd>

21156

21157

<dt> state,   values: <code>INVISIBLE</code>, <code>SMALL</code>, <code>MEDIUM</code>, <code>LARGE</code>;   default: <code>SMALL</code>   See section <a href="#state">state</a></dt>

21158

<dt> flavor,   values: <code>"abyss"</code>, <code>"water"</code>;   default: <code>"abyss"</code></dt>

21159

<dt> spreading   values: positive number between 0.0 and 1.0;   default: <code>0.5</code>,   See section <a href="#CrackSpreading">CrackSpreading</a></dt>

21160

<dt> fragility   values: positive number between 0.0 and 1.0;   default: <code>1.0</code>,   See section <a href="#Fragility">Fragility</a></dt>

21161

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

21162

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

21163

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

21164

</dl>

21165

21166

</dd>

21167

<dt> Messages:</dt>

21168

<dd>

21169

21170

<dt> crack</dt>

21171

<dt> toggle   See section <a href="#toggle">toggle</a></dt>

21172

<dt> ignite   See section <a href="#ignite">ignite</a></dt>

21173

<dt> heat   See section <a href="#heat">heat</a></dt>

21174

</dl>

21175

21176

</dd>

21177

<dt> Variants:</dt>

21178

21179

<tr><td width="8%"><img src="images/it_crack_abyss.png" alt="images/it_crack_abyss"></td><td width="42%">it_crack: state = <code>SMALL</code>, flavor = <code>"abyss"</code></td><td width="8%"><img src="images/it_crack_water.png" alt="images/it_crack_water"></td><td width="42%">it_crack: state = <code>SMALL</code>, flavor = <code>"water"</code></td></tr>

21180

<tr><td width="8%"><img src="images/fl_white.png" alt="images/fl_white"></td><td width="42%">it_crack_i: state = <code>INVISIBLE</code>, flavor = <code>"abyss"</code></td><td width="8%"><img src="images/fl_white.png" alt="images/fl_white"></td><td width="42%">it_crack_i: state = <code>INVISIBLE</code>, flavor = <code>"water"</code></td></tr>

21181

<tr><td width="8%"><img src="images/it_crack_abyss.png" alt="images/it_crack_abyss"></td><td width="42%">it_crack_s: state = <code>SMALL</code>, flavor = <code>"abyss"</code></td><td width="8%"><img src="images/it_crack_water.png" alt="images/it_crack_water"></td><td width="42%">it_crack_s: state = <code>SMALL</code>, flavor = <code>"water"</code></td></tr>

21182

<tr><td width="8%"><img src="images/it_crack_abyss_2.png" alt="images/it_crack_abyss_2"></td><td width="42%">it_crack_m: state = <code>MEDIUM</code>, flavor = <code>"abyss"</code></td><td width="8%"><img src="images/it_crack_water_2.png" alt="images/it_crack_water_2"></td><td width="42%">it_crack_m: state = <code>MEDIUM</code>, flavor = <code>"water"</code></td></tr>

21183

<tr><td width="8%"><img src="images/it_crack_abyss_3.png" alt="images/it_crack_abyss_3"></td><td width="42%">it_crack_l: state = <code>LARGE</code>, flavor = <code>"abyss"</code></td><td width="8%"><img src="images/it_crack_water_3.png" alt="images/it_crack_water_3"></td><td width="42%">it_crack_l: state = <code>LARGE</code>, flavor = <code>"water"</code></td></tr>

21184

</table>

21185

21186

</dd>

21187

</dl>

21188

21189

21190

21191

21192

21193

21194

21195

21196

21197

21198

21199

21200

21201

21202

21203

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

21204

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

21205

21206

</tr></table>

21207

21208

<h3 class="subsection">8.4.5 it_cross</h3>

21209

21210

21211

An eye-catching cross spot that can detect actors staying on it for a given

21212

time. When an actor remains on top of the cross for the given ‘<samp>interval</samp>’

21213

without any other actor leaving or passing the cross grid the cross will perform

21214

its action. Similar, but instant sensors for actors are <a href="#it_005fsensor">it_sensor</a> and

21215

<a href="#it_005ftrigger">it_trigger</a>

21216

21217

A cross can be drawn with an <a href="#it_005fpencil">it_pencil</a> and it can be removed with an

21218

<a href="#it_005fbrush">it_brush</a>.

21219

21220

An <a href="#st_005flightpassenger">st_lightpassenger</a> moving onto a cross item will switch off.

21221

21222

21223

<dt> Attributes:</dt>

21224

<dd>

21225

21226

<dt> state,   values: <code>0</code>, <code>1</code>;   access: <code>read only</code>   See section <a href="#state">state</a></dt>

21227

<dd>The current state - ‘<samp>0</samp>’ for the last event being an actor leaving the cross,

21228

‘<samp>1</samp>’ for the last event being an actor entering the cross.

21229

21230

</dd>

21231

<dt> interval   values: positive number;   default: <code>10.0</code></dt>

21232

<dd>Number of seconds that the actor must stay on the sensor to cause an action.

21233

</dd>

21234

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

21235

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

21236

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

21237

</dl>

21238

21239

</dd>

21240

<dt> Messages: none</dt>

21241

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

21242

<dt> Variants:</dt>

21243

21244

<dt> <img src="images/it_cross.png" alt="images/it_cross"> it_cross

21245

</dt>

21246

</dl>

21247

</dd>

21248

</dl>

21249

21250

21251

21252

21253

21254

21255

21256

21257

21258

21259

21260

21261

21262

21263

21264

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

21265

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

21266

21267

</tr></table>

21268

21269

<h3 class="subsection">8.4.6 it_death</h3>

21270

21271

21272

This item shatters any marble that tries to pass the grid. Even jumping marbles

21273

will be shattered. Just marbles protected by an activated <a href="#it_005fumbrella">it_umbrella</a> can

21274

pass without taking harm. Apart from that an ‘<samp>it_death</samp>’ barrier can only be

21275

passed by walking around the complete barrier or by warping through an

21276

<a href="#it_005fvortex">it_vortex</a>, an <a href="#it_005fwormhole">it_wormhole</a> or by means of an <a href="#it_005fring">it_ring</a>.

21277

21278

The death item is the most secure barrier object. Comparable objects are

21279

<a href="#it_005fbottle">it_bottle</a>_broken, <a href="#fl_005fabyss">fl_abyss</a>, <a href="#fl_005fwater">fl_water</a>, <a href="#it_005ftrap">it_trap</a> or simply

21280

any solid wall of stones. Usually these alternatives should be favored. The

21281

death item should mainly be used when all other alternatives are too insecure.

21282

21283

21284

<dt> Attributes:</dt>

21285

21286

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

21287

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

21288

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

21289

</dl>

21290

21291

</dd>

21292

<dt> Messages: none</dt>

21293

<dt> Variants:</dt>

21294

21295

<dt> <img src="images/it_death.png" alt="images/it_death"> it_death

21296

</dt>

21297

</dl>

21298

21299

</dd>

21300

</dl>

21301

21302

21303

21304

21305

21306

21307

21308

21309

21310

21311

21312

21313

21314

21315

21316

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

21317

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

21318

21319

</tr></table>

21320

21321

<h3 class="subsection">8.4.7 it_explosion</h3>

21322

21323

21324

An intermediate short living system item representing and visualizing an

21325

explosion. There are very few acceptable usages of this item besides the

21326

internal setting due to explosions of <a href="#it_005fbomb">it_bomb</a>, <a href="#it_005fdynamite">it_dynamite</a>,

21327

<a href="#it_005flandmine">it_landmine</a> and <a href="#ot_005fcannonball">ot_cannonball</a>.

21328

21329

All explosions do shatter ball like actors.

21330

21331

The following variants do exist:

21332

<ul>

21333

<li> ‘<samp>nil</samp>’ - no remnants.

21334

</li><li> ‘<samp>hollow</samp>’ - leave an <a href="#it_005fmeditation">it_meditation</a>_hollow.

21335

</li><li> ‘<samp>crack</samp>’ - make an <a href="#it_005fcrack">it_crack</a>_water.

21336

</li><li> ‘<samp>debris</samp>’ - dissolve the floor to <a href="#SubSoil">SubSoil</a>, which defaults to <a href="#fl_005fabyss">fl_abyss</a>

21337

</li></ul>

21338

21339

Note that you are not allowed to set or change the ‘<samp>state</samp>’ of an explosion

21340

item. But you can investigate the kind of an explosion.

21341

21342

21343

<dt> Attributes:</dt>

21344

21345

<dt> state,   values: integer numbers between 0 and 3;   default: <code>0</code>;   access: <code>read only</code>   See section <a href="#state">state</a></dt>

21346

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

21347

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

21348

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

21349

</dl>

21350

21351

</dd>

21352

<dt> Messages: none</dt>

21353

<dt> Variants:</dt>

21354

21355

<dt> <img src="images/it_explosion.png" alt="images/it_explosion"> it_explosion: state = <code>0</code>

21356

</dt>

21357

<dt> <img src="images/it_explosion.png" alt="images/it_explosion"> it_explosion_nil: state = <code>0</code>

21358

</dt>

21359

<dt> <img src="images/it_explosion.png" alt="images/it_explosion"> it_explosion_hollow: state = <code>1</code>

21360

</dt>

21361

<dt> <img src="images/it_explosion.png" alt="images/it_explosion"> it_explosion_crack: state = <code>2</code>

21362

</dt>

21363

<dt> <img src="images/it_explosion.png" alt="images/it_explosion"> it_explosion_debris: state = <code>3</code>

21364

</dt>

21365

</dl>

21366

21367

</dd>

21368

</dl>

21369

21370

21371

21372

21373

21374

21375

21376

21377

21378

21379

21380

21381

21382

21383

21384

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

21385

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

21386

21387

</tr></table>

21388

21389

<h3 class="subsection">8.4.8 it_landmine</h3>

21390

21391

21392

A static item that explodes on actors stepping onto its critical center part and

21393

on stones being pushed onto the mine.

21394

21395

The landmine explodes shattering nearby marbles on the same grid and leaves an

21396

hollow <a href="#it_005fmeditation">it_meditation</a> behind.

21397

21398

Actors can jump over a landmine and pass carefully between two adjacent

21399

landmines without activating the mines. Landmines do neither react on nearby

21400

explosions, nor fire, nor laserbeams.

21401

21402

21403

<dt> Attributes:</dt>

21404

21405

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

21406

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

21407

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

21408

</dl>

21409

21410

</dd>

21411

<dt> Messages: none</dt>

21412

<dt> Action: none</dt>

21413

<dt> Variants:</dt>

21414

21415

<dt> <img src="images/it_landmine.png" alt="images/it_landmine"> it_landmine

21416

</dt>

21417

</dl>

21418

21419

</dd>

21420

</dl>

21421

21422

21423

21424

21425

21426

21427

21428

21429

21430

21431

21432

21433

21434

21435

21436

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

21437

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

21438

21439

</tr></table>

21440

21441

<h3 class="subsection">8.4.9 it_laserbeam</h3>

21442

21443

21444

A beam of laser light. This item is caused by an <a href="#st_005flaser">st_laser</a> that is switched

21445

on. The beam is automatically calculated and the items are set by the engine.

21446

You can not set laser beam items on your own. But you may detect a beam as an

21447

item being located on the item layer. You are free to replace a laser beam item

21448

by another item. This causes automatically a recalculation of the laser light.

21449

21450

21451

<dt> Attributes:</dt>

21452

21453

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

21454

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

21455

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

21456

</dl>

21457

</dd>

21458

<dt> Messages: none</dt>

21459

<dt> Variants:</dt>

21460

21461

<dt> <img src="images/it_laser.png" alt="images/it_laser"> it_laserbeam can not be instantiated by levels

21462

</dt>

21463

</dl>

21464

</dd>

21465

</dl>

21466

21467

21468

21469

21470

21471

21472

21473

21474

21475

21476

21477

21478

21479

21480

21481

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

21482

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

21483

21484

</tr></table>

21485

21486

<h3 class="subsection">8.4.10 it_magnet</h3>

21487

21488

21489

Attracts or repels actors in its ‘<samp>range</samp>’ with a force proportional to the

21490

‘<samp>strength</samp>’ and the inverse of the squared distance. A magnet can be

21491

switched ‘<samp>ON</samp>’ and ‘<samp>OFF</samp>’.

21492

21493

Note that no forces are applied to actors at a distance smaller than 0.05 grids

21494

to avoid extraordinary large forces.

21495

21496

21497

<dt> Attributes:</dt>

21498

<dd>

21499

21500

<dt> state,   values: <code>ON</code>, <code>OFF</code>;   default: <code>OFF</code>   See section <a href="#state">state</a></dt>

21501

<dd>The current magnet state - ‘<samp>ON</samp>’ for an active magnet, ‘<samp>OFF</samp>’ for an

21502

inactive magnet.

21503

21504

</dd>

21505

<dt> range   values: float number greater or equal 0;   default: <code>10.0</code>   See section <a href="#MagnetRange">MagnetRange</a></dt>

21506

<dd>The distance up to which the magnet applies forces to actors.

21507

21508

</dd>

21509

<dt> strength   values: float number;   default: <code>+30.0</code>   See section <a href="#MagnetStrength">MagnetStrength</a></dt>

21510

<dd>A scalar factor for magnet forces. Positive numbers are attracting forces

21511

where as negative numbers are repelling forces.

21512

</dd>

21513

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

21514

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

21515

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

21516

</dl>

21517

21518

</dd>

21519

<dt> Messages:</dt>

21520

<dd>

21521

21522

<dt> signal   See section <a href="#signal">signal</a></dt>

21523

<dd>A signal of value 1 switches the magnet on, a value of 0 switches the magnet off.

21524

</dd>

21525

<dt> toggle   See section <a href="#toggle">toggle</a></dt>

21526

<dd>A toggle causes a change in the magnet activity state.

21527

</dd>

21528

<dt> on   See section <a href="#on">on</a></dt>

21529

<dd>Switches the magnet on.

21530

</dd>

21531

<dt> off   See section <a href="#off">off</a></dt>

21532

<dd>Switches the magnet off.

21533

</dd>

21534

</dl>

21535

21536

</dd>

21537

<dt> Action:</dt>

21538

<dd>none

21539

21540

</dd>

21541

<dt> Variants:</dt>

21542

21543

<dt> <img src="images/it_magnet_off.png" alt="images/it_magnet_off"> it_magnet state = ‘<samp>OFF</samp>’.

21544

</dt>

21545

<dt> <img src="images/it_magnet_on.png" alt="images/it_magnet_on"> it_magnet_on state = ‘<samp>ON</samp>’.

21546

</dt>

21547

<dt> <img src="images/it_magnet_off.png" alt="images/it_magnet_off"> it_magnet_off state = ‘<samp>OFF</samp>’.

21548

</dt>

21549

</dl>

21550

21551

</dd>

21552

</dl>

21553

21554

21555

21556

21557

21558

21559

21560

21561

21562

21563

21564

21565

21566

21567

21568

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

21569

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

21570

21571

</tr></table>

21572

21573

<h3 class="subsection">8.4.11 it_meditation</h3>

21574

21575

21576

Meditation items are small round areas of flatness imperfection. All actors will

21577

experience the slope forces that can be modified by the global scalar factor

21578

<a href="#MeditationStrength">MeditationStrength</a>. There are different shapes of meditation items that

21579

are named according to their shape: <code>MEDITATION_CALDERA</code>,

21580

<code>MEDITATION_HOLLOW</code>, <code>MEDITATION_DENT</code>, <code>MEDITATION_BUMP</code>,

21581

<code>MEDITATION_HILL</code>, <code>MEDITATION_VOLCANO</code>.

21582

21583

Of special interest are <a href="#ac_005fpearl">ac_pearl</a>s resting on a meditation item. They are

21584

counted as meditating after staying continuously for one second within the round

21585

area of the item. One of the two <a href="#Ending-Conditions">Ending Conditions</a> of the game is that all

21586

meditation marbles come to rest on mediation items.

21587

21588

As meditation items can dynamically be generated during the game by exploding

21589

<a href="#it_005flandmine">it_landmine</a> or <a href="#it_005fdynamite">it_dynamite</a> it may be necessary for an author to

21590

mark those meditation items that are required to be filled with meditation

21591

marbles. You do this by setting the ‘<samp>essential</samp>’ attribute to <code>true</code>.

21592

Please make rare and obvious usage of this attribute, as the player can not

21593

distinguish essential from not essential meditation items by their images.

21594

21595

Meditation items can transform into other shapes by various means.

21596

21597

First a user can push a solid stone over a meditation item or activate an

21598

<a href="#it_005fspade">it_spade</a> on it. Both actions flatten the meditation, either

21599

<code>MEDITATION_VOLCANO</code> -> <code>MEDITATION_HILL</code> -> <code>MEDITATION_BUMP</code>

21600

-> <code>it_nil</code> or <code>MEDITATION_CALDERA</code> -> <code>MEDITATION_HOLLOW</code> ->

21601

<code>MEDITATION_DENT</code> -> <code>it_nil</code>.

21602

21603

Secondly you can send a <code>"flip"</code> message to a meditation item which

21604

transforms hollow like items into their hill like counterparts and vice versa:

21605

<code>MEDITATION_VOLCANO</code> <-> <code>MEDITATION_CALDERA</code>, <code>MEDITATION_HILL</code>

21606

<-> <code>MEDITATION_HOLLOW</code>, <code>MEDITATION_BUMP</code> <-> <code>MEDITATION_DENT</code>.

21607

21608

Third a <code>"signal"</code> message flips on a <code>1</code> value all meditations to

21609

their hill like counterparts, keeping hill like meditations unchanged, and on a

21610

<code>0</code> value to their hollow like counterparts, keeping hollow like meditations

21611

unchanged.

21612

21613

A fourth message is <code>"toggle"</code>. It transforms <code>MEDITATION_HOLLOW</code> <->

21614

<code>MEDITATION_VOLCANO</code>, <code>MEDITATION_CALDERA</code> <-> <code>MEDITATION_HILL</code>,

21615

<code>MEDITATION_BUMP</code> <-> <code>MEDITATION_DENT</code>.

21616

21617

Of course you can change the state by setting the attribute anytime in any sequence

21618

you like. Essentialness is kept on shape transformations and mediation actor

21619

counting is updated and continues.

21620

21621

21622

<dt> Attributes:</dt>

21623

21624

<dt> state,   values: <code>MEDITATION_CALDERA</code>, <code>MEDITATION_HOLLOW</code>, <code>MEDITATION_DENT</code>, <code>MEDITATION_BUMP</code>, <code>MEDITATION_HILL</code>, <code>MEDITATION_VOLCANO</code>;   default: <code>MEDITATION_HOLLOW</code>   See section <a href="#state">state</a></dt>

21625

<dd>The shape of the meditation.

21626

</dd>

21627

<dt> essential   values: <code>DISPENSABLE</code>, <code>INDISPENSABLE</code>;   default: <code>DISPENSABLE</code></dt>

21628

<dd>Essentialness of being filled with a meditation marble to fulfill the

21629

<a href="#Ending-Conditions">Ending Conditions</a>.

21630

</dd>

21631

<dt> friction,   values: number;   default: <code>nil</code>   See section <a href="#friction">friction</a></dt>

21632

<dd>Deviating friction that defaults to floor friction.

21633

</dd>

21634

<dt> adhesion,   values: number;   default: <code>nil</code>   See section <a href="#adhesion">adhesion</a></dt>

21635

<dd>Deviating adhesion that defaults to floor adhesion.

21636

</dd>

21637

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

21638

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

21639

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

21640

</dl>

21641

21642

</dd>

21643

<dt> Messages:</dt>

21644

21645

21646

<dd>Shape transformation. See text above.

21647

</dd>

21648

<dt> shovel</dt>

21649

<dd>Shape transformation like an activated <a href="#it_005fspade">it_spade</a>. See text above.

21650

</dd>

21651

<dt> signal   See section <a href="#signal">signal</a></dt>

21652

<dd>Shape transformation. See text above.

21653

</dd>

21654

<dt> toggle</dt>

21655

<dd>Shape transformation. See text above.

21656

</dd>

21657

</dl>

21658

21659

</dd>

21660

<dt> Variants:</dt>

21661

21662

<dt> <img src="images/it_meditation_hollow.png" alt="images/it_meditation_hollow"> it_meditation state = <code>MEDITATION_HOLLOW</code>

21663

</dt>

21664

<dt> <img src="images/it_meditation_caldera.png" alt="images/it_meditation_caldera"> it_meditation_caldera state = <code>MEDITATION_CALDERA</code>

21665

</dt>

21666

<dt> <img src="images/it_meditation_hollow.png" alt="images/it_meditation_hollow"> it_meditation_hollow state = <code>MEDITATION_HOLLOW</code>

21667

</dt>

21668

<dt> <img src="images/it_meditation_dent.png" alt="images/it_meditation_dent"> it_meditation_dent state = <code>MEDITATION_DENT</code>

21669

</dt>

21670

<dt> <img src="images/it_meditation_bump.png" alt="images/it_meditation_bump"> it_meditation_bump state = <code>MEDITATION_BUMP</code>

21671

</dt>

21672

<dt> <img src="images/it_meditation_hill.png" alt="images/it_meditation_hill"> it_meditation_hill state = <code>MEDITATION_HILL</code>

21673

</dt>

21674

<dt> <img src="images/it_meditation_volcano.png" alt="images/it_meditation_volcano"> it_meditation_volcano state = <code>MEDITATION_VOLCANO</code>

21675

</dt>

21676

</dl>

21677

21678

</dd>

21679

</dl>

21680

21681

21682

21683

21684

21685

21686

21687

21688

21689

21690

21691

21692

21693

21694

21695

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

21696

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

21697

21698

</tr></table>

21699

21700

<h3 class="subsection">8.4.12 it_sensor</h3>

21701

21702

21703

The sensor item is a switch on top of a floor that reacts on actors passing it.

21704

It performs actions on actors either entering or exiting the sensors grid

21705

depending on its attribute ‘<samp>exit</samp>’. It will send the causing actor as action

21706

value, which evaluates like ‘<samp>true</samp>’ in Lua, but nevertheless the <a href="#inverse">inverse</a>

21707

attribute can be used to send an action value of ‘<samp>false</samp>’ instead.

21708

21709

Any actors passing the grid, either on the floor or jumping over it will be

21710

detected.

21711

21712

Sensors do not cause any noise. Visible sensors will nevertheless flash on

21713

passing actors. You can make the trigger invisible by setting its attribute.

21714

Be aware that the user will still notice that actors cannot drop items onto the

21715

same grid position.

21716

21717

The level author can configure <a href="#it_005fglasses">it_glasses</a> by addition of

21718

‘<samp>SPOT_SENSOR</samp>’ to show invisible sensor items. An actor with such an

21719

<a href="#it_005fglasses">it_glasses</a> in its inventory will be able to spot invisible sensor items.

21720

With the global attribute <a href="#ExtralifeGlasses">ExtralifeGlasses</a> even glasses generated by laser

21721

lighting an <a href="#it_005fextralife">it_extralife</a> can be configured not to show invisible sensor

21722

items.

21723

21724

Alternative objects that react on actors are <a href="#it_005ftrigger">it_trigger</a> and

21725

<a href="#it_005fcross">it_cross</a>.

21726

21727

21728

<dt> Attributes:</dt>

21729

21730

<dt> invisible   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

21731

<dd>An invisible sensor is totally transparent. But the user may notice it, as actors

21732

cannot drop items onto the same grid position.

21733

</dd>

21734

<dt> exit   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

21735

<dd>React either on an actor exiting or entering the grid.

21736

</dd>

21737

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

21738

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

21739

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

21740

</dl>

21741

21742

</dd>

21743

<dt> Messages: none</dt>

21744

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

21745

<dt> Variants:</dt>

21746

21747

<dt> <img src="images/it_sensor.png" alt="images/it_sensor"> it_sensor: exit = <code>false</code>

21748

</dt>

21749

<dt> <img src="images/it_sensor_exit.png" alt="images/it_sensor_exit"> it_sensor_exit: exit = <code>true</code>

21750

</dt>

21751

</dl>

21752

21753

</dd>

21754

</dl>

21755

21756

21757

21758

21759

21760

21761

21762

21763

21764

21765

21766

21767

21768

21769

21770

21771

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

21772

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

21773

21774

</tr></table>

21775

21776

<h3 class="subsection">8.4.13 it_shogun</h3>

21777

21778

21779

A dot like, blue animated sensor item for <a href="#st_005fshogun">st_shogun</a> stones. The dot comes

21780

in three variations matching the different hole sizes of shogun stones.

21781

21782

Shogun dots detect stacks of <a href="#st_005fshogun">st_shogun</a> that contain all variations from

21783

small up to the size of the dot. Thus the small dot requires just a single small

21784

shogun stone, the middle sized dot requires a stack of a small shogun beneath

21785

a middle sized shogun stone, whereas the large dot requires a stack of all three

21786

shogun stones on top.

21787

21788

There is no way to set the state of a dot manually. But the state can

21789

nevertheless be read. At initialization a dot with a matching shogun stack on

21790

top will start in state ‘<samp>ON</samp>’ without sending actions due to the

21791

<a href="#Snapshot-Principle">Snapshot Principle</a>.

21792

21793

Note that a dot is freezable by an <a href="#st_005fice">st_ice</a> and can thus be relocated to

21794

another position.

21795

21796

21797

<dt> Attributes:</dt>

21798

21799

<dt> state,   values: <code>OFF</code>, <code>ON</code>;   default: <code>OFF</code>;   access: <code>read only</code>   See section <a href="#state">state</a></dt>

21800

<dd>The current state of the dot - ‘<samp>ON</samp>’ for a matching <a href="#st_005fshogun">st_shogun</a> stack

21801

on top, ‘<samp>OFF</samp>’ otherwise.

21802

</dd>

21803

<dt> flavor,   values: <code>"s"</code>, <code>"m"</code>, <code>"l"</code>;   default: <code>"s"</code></dt>

21804

<dd>A string describing the hole size. <code>"s"</code> for a small hole, <code>"m"</code> for

21805

a medium hole, <code>"l"</code> for a large hole.

21806

21807

</dd>

21808

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

21809

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

21810

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

21811

</dl>

21812

21813

</dd>

21814

<dt> Messages: none</dt>

21815

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

21816

<dt> Variants:</dt>

21817

21818

<dt> <img src="images/it_shogun_s.png" alt="images/it_shogun_s"> it_shogun: flavor = <code>"s"</code>

21819

</dt>

21820

<dt> <img src="images/it_shogun_s.png" alt="images/it_shogun_s"> it_shogun_s: flavor = <code>"s"</code>

21821

</dt>

21822

<dt> <img src="images/it_shogun_m.png" alt="images/it_shogun_m"> it_shogun_m: flavor = <code>"m"</code>

21823

</dt>

21824

<dt> <img src="images/it_shogun_l.png" alt="images/it_shogun_l"> it_shogun_l: flavor = <code>"l"</code>

21825

</dt>

21826

</dl>

21827

21828

</dd>

21829

</dl>

21830

21831

21832

21833

21834

21835

21836

21837

21838

21839

21840

21841

21842

21843

21844

21845

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

21846

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

21847

21848

</tr></table>

21849

21850

<h3 class="subsection">8.4.14 it_springboard</h3>

21851

21852

21853

A static jump facility that lets <a href="#Flying-Actors">Flying Actors</a> jump on passing its center

21854

square. A springboard can catapult any number of actors anytime with an idle

21855

reloading time after an activation.

21856

21857

A springboard positioned on top of a floor can not be picked up. But nevertheless

21858

as being portable, it can be added to the initial inventory, to an <a href="#it_005fbag">it_bag</a>

21859

or can be picked up as a result of a <a href="#it_005fsurprise">it_surprise</a>.

21860

21861

Another catapulting, but liftable item is <a href="#it_005fspring">it_spring</a>.

21862

21863

21864

<dt> Attributes:</dt>

21865

21866

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

21867

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

21868

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

21869

</dl>

21870

</dd>

21871

<dt> Messages: none</dt>

21872

<dt> Variants:</dt>

21873

21874

<dt> <img src="images/it_springboard.png" alt="images/it_springboard"> it_springboard

21875

</dt>

21876

</dl>

21877

21878

</dd>

21879

</dl>

21880

21881

21882

21883

21884

21885

21886

21887

21888

21889

21890

21891

21892

21893

21894

21895

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

21896

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

21897

21898

</tr></table>

21899

21900

<h3 class="subsection">8.4.15 it_squashed</h3>

21901

21902

21903

The remnants of fruits like <a href="#it_005fcherry">it_cherry</a> and <a href="#it_005fbanana">it_banana</a> after pushing

21904

a stone over it.

21905

21906

The squashed remnants are scarcely visible on some floor types. The player can

21907

not pick them up. But it can be wiped away by application of an <a href="#it_005fbrush">it_brush</a>,

21908

by a nearby exploding <a href="#it_005fbomb">it_bomb</a> or by an <a href="#st_005fice">st_ice</a> being pushed over it.

21909

21910

21911

<dt> Attributes:</dt>

21912

21913

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

21914

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

21915

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

21916

</dl>

21917

</dd>

21918

<dt> Messages: none</dt>

21919

<dt> Variants:</dt>

21920

21921

<dt> <img src="images/it_squashed.png" alt="images/it_squashed"> it_squashed

21922

</dt>

21923

</dl>

21924

</dd>

21925

</dl>

21926

21927

21928

21929

21930

21931

21932

21933

21934

21935

21936

21937

21938

21939

21940

21941

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

21942

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

21943

21944

</tr></table>

21945

21946

<h3 class="subsection">8.4.16 it_strip</h3>

21947

21948

21949

These items cover a small strip of the ground below them and provide a narrow

21950

bridge for the marble to safely pass <a href="#fl_005fabyss">fl_abyss</a>, <a href="#fl_005fswamp">fl_swamp</a>,

21951

<a href="#fl_005fwater">fl_water</a>, or any other floor.

21952

21953

A strip connects zero, what is just a central small unconnected square, or up

21954

to 4 neighboring floor grids. A marble can pass from one connected floor to

21955

another connected floor via the strip.

21956

21957

Any stone on a directly neighboring grid can be touched or hit by a large marble

21958

and prevents it from falling off the strip on this side. Small marbles can not

21959

touch neighboring stones and will not be protected from falling.

21960

21961

Per default an actor on a covering strip is exposed to the same friction and

21962

adhesion as on the floor below. But strips can provide its own deviating

21963

values for these factors.

21964

21965

21966

<dt> Attributes:</dt>

21967

21968

<dt> connections,   values: string;   default: <code>nil</code></dt>

21969

<dd>Describes the connections to the neighbor grids. The string is a substring of

21970

<code>"nesw"</code> listing the existing connections. The sequence of the sides, north,

21971

east, south, west, is guaranteed on read access but arbitrary on write access.

21972

</dd>

21973

<dt> friction,   values: number;   default: <code>nil</code>   See section <a href="#friction">friction</a></dt>

21974

<dd>Deviating friction that defaults to floor friction.

21975

</dd>

21976

<dt> adhesion,   values: number;   default: <code>nil</code>   See section <a href="#adhesion">adhesion</a></dt>

21977

<dd>Deviating adhesion that defaults to floor adhesion.

21978

</dd>

21979

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>true</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

21980

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

21981

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

21982

</dl>

21983

21984

</dd>

21985

<dt> Variants:</dt>

21986

21987

<tr><td width="8%"><img src="images/it_strip.png" alt="images/it_strip"></td><td width="42%">it_strip: connections = <code>""</code></td><td width="8%"><img src="images/it_strip_2.png" alt="images/it_strip_2"></td><td width="42%">it_strip_w: connections = <code>"w"</code></td></tr>

21988

<tr><td width="8%"><img src="images/it_strip_3.png" alt="images/it_strip_3"></td><td width="42%">it_strip_s: connections = <code>"s"</code></td><td width="8%"><img src="images/it_strip_4.png" alt="images/it_strip_4"></td><td width="42%">it_strip_sw: connections = <code>"sw"</code></td></tr>

21989

<tr><td width="8%"><img src="images/it_strip_b.png" alt="images/it_strip_b"></td><td width="42%">it_strip_e: connections = <code>"e"</code></td><td width="8%"><img src="images/it_strip_b2.png" alt="images/it_strip_b2"></td><td width="42%">it_strip_ew: connections = <code>"ew"</code></td></tr>

21990

<tr><td width="8%"><img src="images/it_strip_b3.png" alt="images/it_strip_b3"></td><td width="42%">it_strip_es: connections = <code>"es"</code></td><td width="8%"><img src="images/it_strip_b4.png" alt="images/it_strip_b4"></td><td width="42%">it_strip_esw: connections = <code>"esw"</code></td></tr>

21991

<tr><td width="8%"><img src="images/it_strip_c.png" alt="images/it_strip_c"></td><td width="42%">it_strip_n: connections = <code>"n"</code></td><td width="8%"><img src="images/it_strip_c2.png" alt="images/it_strip_c2"></td><td width="42%">it_strip_nw: connections = <code>"nw"</code></td></tr>

21992

<tr><td width="8%"><img src="images/it_strip_c3.png" alt="images/it_strip_c3"></td><td width="42%">it_strip_ns: connections = <code>"ns"</code></td><td width="8%"><img src="images/it_strip_c4.png" alt="images/it_strip_c4"></td><td width="42%">it_strip_nsw: connections = <code>"nsw"</code></td></tr>

21993

<tr><td width="8%"><img src="images/it_strip_d.png" alt="images/it_strip_d"></td><td width="42%">it_strip_ne: connections = <code>"ne"</code></td><td width="8%"><img src="images/it_strip_d2.png" alt="images/it_strip_d2"></td><td width="42%">it_strip_new: connections = <code>"new"</code></td></tr>

21994

<tr><td width="8%"><img src="images/it_strip_d3.png" alt="images/it_strip_d3"></td><td width="42%">it_strip_nes: connections = <code>"nes"</code></td><td width="8%"><img src="images/it_strip_d4.png" alt="images/it_strip_d4"></td><td width="42%">it_strip_nesw: connections = <code>"nesw"</code></td></tr>

21995

</table>

21996

</dd>

21997

</dl>

21998

21999

22000

22001

22002

22003

22004

22005

22006

22007

22008

22009

22010

22011

22012

22013

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

22014

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

22015

22016

</tr></table>

22017

22018

22019

22020

22021

A classical trap that is camouflaged by a floor image. Any marble stepping onto

22022

this trap will break the trap and fall into the trap’s abyss. But marbles can

22023

jump unharmed over a trap. Movable stones can be pushed over a trap without any

22024

reaction.

22025

22026

Any marble falling into a trap causes it to break and to become visible by the

22027

remnants of the trap. The trap can be opened by messages, too.

22028

22029

The level author can configure <a href="#it_005fglasses">it_glasses</a> by addition of

22030

‘<samp>SPOT_TRAP</samp>’ to show invisible traps. An actor with such an

22031

<a href="#it_005fglasses">it_glasses</a> in its inventory will be able to spot invisible traps.

22032

With the global attribute <a href="#ExtralifeGlasses">ExtralifeGlasses</a> even glasses generated by laser

22033

lighting an <a href="#it_005fextralife">it_extralife</a> can be configured to show invisible traps.

22034

22035

22036

<dt> Attributes:</dt>

22037

<dd>

22038

22039

<dt> state,   values: <code>CLOSED</code>, <code>OPEN</code>;   default: <code>CLOSED</code>   See section <a href="#state">state</a></dt>

22040

<dd>A ‘<samp>CLOSED</samp>’ trap is intact and invisible, an ‘<samp>OPEN</samp>’ trap is broken and

22041

visible.

22042

</dd>

22043

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

22044

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

22045

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

22046

</dl>

22047

</dd>

22048

<dt> Messages:</dt>

22049

<dd>

22050

22051

<dt> signal   See section <a href="#signal">signal</a></dt>

22052

<dd>Opens the trap on value ‘<samp>1</samp>’

22053

</dd>

22054

<dt> toggle   See section <a href="#toggle">toggle</a></dt>

22055

<dd>Opens the trap.

22056

</dd>

22057

<dt> open   See section <a href="#open">open</a></dt>

22058

<dd>Opens the trap.

22059

</dd>

22060

</dl>

22061

</dd>

22062

<dt> Variants:</dt>

22063

22064

<dt> <img src="images/it_trap.png" alt="images/it_trap"> it_trap

22065

</dt>

22066

</dl>

22067

22068

</dd>

22069

</dl>

22070

22071

22072

22073

22074

22075

22076

22077

22078

22079

22080

22081

22082

22083

22084

22085

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

22086

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

22087

22088

</tr></table>

22089

22090

<h3 class="subsection">8.4.18 it_trigger</h3>

22091

22092

22093

The trigger item is a switch on top of a floor that reacts on actors and

22094

stones on top of it that may press it. It performs actions when it is initially

22095

pressed and again when it releases after the last object left it. A pressed

22096

trigger is in state ‘<samp>ON</samp>’ and will send an action value of ‘<samp>true</samp>’, a

22097

released trigger is in state ‘<samp>OFF</samp>’ and will send an action value of

22098

‘<samp>false</samp>’.

22099

22100

Only actors moving on the floor will press triggers. An actor jumping over a

22101

trigger will not press it. An actor jumping on a trigger will release and press

22102

it again.

22103

22104

Just solid stones will press the trigger when pushed onto it. Floating, hollow

22105

stones will generally not press the trigger with the exception of the hollow,

22106

central puzzle stone (see section <a href="#st_005fpuzzle">st_puzzle</a>).

22107

22108

There is no way to set the state of a trigger manually. But the state can

22109

nevertheless be read. At initialization a trigger that is pressed by objects

22110

will start in state ‘<samp>ON</samp>’ without sending actions due to the

22111

<a href="#Snapshot-Principle">Snapshot Principle</a>.

22112

22113

You can make the trigger invisible by setting its attribute. Be aware that it

22114

still produces its click-sounds and the user will notice that actors cannot drop

22115

items onto the same grid position.

22116

22117

Alternative items that react just on actors are <a href="#it_005fsensor">it_sensor</a> and

22118

<a href="#it_005fcross">it_cross</a>. Another switch that reacts on the actors mass and stones are

22119

the <a href="#fl_005fscales">fl_scales</a>.

22120

22121

22122

<dt> Attributes:</dt>

22123

<dd>

22124

22125

<dt> state,   values: <code>ON</code>, <code>OFF</code>;   access: <code>read only</code>   See section <a href="#state">state</a></dt>

22126

<dd>The current switch state - ‘<samp>ON</samp>’ for a pressed trigger, ‘<samp>OFF</samp>’ for a

22127

released trigger.

22128

22129

</dd>

22130

<dt> invisible   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

22131

<dd>An invisible trigger is totally transparent. But the user may notice it, as actors

22132

cannot drop items onto the same grid position.

22133

22134

</dd>

22135

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

22136

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

22137

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

22138

</dl>

22139

22140

</dd>

22141

<dt> Messages: none</dt>

22142

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

22143

<dt> Variants:</dt>

22144

22145

<dt> <img src="images/it_trigger.png" alt="images/it_trigger"> it_trigger

22146

</dt>

22147

</dl>

22148

22149

</dd>

22150

</dl>

22151

22152

22153

22154

22155

22156

22157

22158

22159

22160

22161

22162

22163

22164

22165

22166

22167

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

22168

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

22169

22170

</tr></table>

22171

22172

<h3 class="subsection">8.4.19 it_vortex</h3>

22173

22174

22175

Teleports <a href="#ac_005fmarble">ac_marble</a> and <a href="#ac_005fpearl">ac_pearl</a> to a given ‘<samp>destination</samp>’.

22176

Unlike <a href="#it_005fwormhole">it_wormhole</a> it does not teleport other <a href="#Actors">Actors</a>.

22177

22178

In the simplest case, a vortex is connected to a single destination given by

22179

an object or a position. If the destination is not blocked by a stone the

22180

actor will be teleported to the destination.

22181

22182

If multiple destination addresses are given, the actor will be teleported

22183

to the single destinations in sequence. Blocked destinations are indicated by

22184

sparkles. Finally the actor exists on the first unblocked destination. If no

22185

unblocked destination exists the marble exists at the starting vortex. A level

22186

author can write nice puzzle which require the user to block destinations to

22187

reach the final destination of a vortex.

22188

22189

Vortices can be ‘<samp>OPEN</samp>’ or ‘<samp>CLOSED</samp>’. Of course an actor can enter just

22190

an open vortex. Closed vortices at the destination are opened automatically.

22191

By default such vortices remain open. By usage of the attribute ‘<samp>autoclose</samp>’

22192

you can configure a vortex to close after an actor has been emitted. This helps

22193

the user to leave the vortex by keeping the marble from being reinserted into

22194

the vortex. Of course an autoclose disables the user to return, too. If this

22195

is not your intention you set additionally the attribute ‘<samp>autoopen</samp>’ to

22196

<code>true</code>. The vortex will reopen again when the marble leaves the closed

22197

vortex. If the user did directly jump out of the vortex, it will reopen when

22198

the user enters the vortex grid again.

22199

22200

Actors are emitted by vortices in a jumping fashion. The user can accelerate

22201

the actor for a short period and the actor may jump out of a vortex into the

22202

desired direction.

22203

22204

Vortex teleportation takes a short amount of time and the involved vortices are

22205

blocked for other teleporting request during this process. Thus it is no problem

22206

to set up destinations of vortices that build a cycle.

22207

22208

Rubberbands bound to teleported actors are cut by default. The attribute

22209

‘<samp>scissor</samp>’ allows you to control the cutting behaviour.

22210

22211

But the teleporting feature of a vortices is not limited to actors. A water

22212

flood will spread through a vortex, too. In contrast to actors the flood will

22213

spread to all destinations at the same time. Of course a closed vortex on

22214

either side of the teleportation will block a flood from spreading. But the

22215

flood continues as soon as the vortices are opened again. Destinations will

22216

not be blocked by stones for a flood penetrating the grid from beneath, but

22217

may block the water from spreading further from the destination grid positions.

22218

All important details are explained in section <a href="#Flood-Spreading">Flood Spreading</a>.

22219

22220

22221

<dt> Attributes:</dt>

22222

22223

<dt> state,   values: <code>OPEN</code>, <code>CLOSED</code>;   default: <code>OPEN</code>   See section <a href="#state">state</a></dt>

22224

<dd>The visual state of a vortex. An ‘<samp>OPEN</samp>’ vortex may still be busy due

22225

to ongoing teleportations and may not accept a marble.

22226

22227

</dd>

22228

<dt> destination,   values: tokens or position;   default: <code>nil</code>   See section <a href="#destination">destination</a></dt>

22229

<dd>The destination of the teleport given by an object or a position.

22230

22231

</dd>

22232

<dt> autoclose,   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

22233

<dd>Flag that indicates whether the vortex should be closed after a teleport.

22234

22235

</dd>

22236

<dt> autoopen,   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

22237

<dd>Flag that indicates whether the vortex should open when an actor enters the grid

22238

or leaves the vortex.

22239

22240

</dd>

22241

<dt> scissor,   values: <code>true</code>, <code>false</code>;   default: <code>true</code></dt>

22242

<dd>Rubberband cutting behaviour on teleporting.

22243

</dd>

22244

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

22245

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

22246

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

22247

</dl>

22248

22249

</dd>

22250

<dt> Messages:</dt>

22251

22252

<dt> signal   See section <a href="#signal">signal</a></dt>

22253

<dd>Opens the vortex on value ‘<samp>1</samp>’, and closes the vortex on value ‘<samp>0</samp>’.

22254

</dd>

22255

<dt> toggle   See section <a href="#toggle">toggle</a></dt>

22256

<dd>Opens a closed vortex and closes an open vortex if possible.

22257

</dd>

22258

<dt> open   See section <a href="#open">open</a></dt>

22259

<dd>Tries to open the vortex.

22260

</dd>

22261

<dt> close   See section <a href="#close">close</a></dt>

22262

<dd>Tries to close the vortex.

22263

</dd>

22264

</dl>

22265

22266

</dd>

22267

<dt> Action: none</dt>

22268

<dt> Variants:</dt>

22269

22270

<dt> <img src="images/it_vortex.png" alt="images/it_vortex"> it_vortex: state = <code>OPEN</code>.

22271

</dt>

22272

<dt> <img src="images/it_vortex.png" alt="images/it_vortex"> it_vortex_open: state = <code>OPEN</code>.

22273

</dt>

22274

<dt> <img src="images/it_vortex_4.png" alt="images/it_vortex_4"> it_vortex_closed: state ‘<samp>CLOSED</samp>’.

22275

</dt>

22276

</dl>

22277

</dd>

22278

</dl>

22279

22280

22281

22282

22283

22284

22285

22286

22287

22288

22289

22290

22291

22292

22293

22294

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

22295

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

22296

22297

</tr></table>

22298

22299

<h3 class="subsection">8.4.20 it_wormhole</h3>

22300

22301

22302

Teleports <a href="#Actors">Actors</a> of any kind to a given ‘<samp>destination</samp>’. Unlike

22303

<a href="#it_005fvortex">it_vortex</a> every wormhole has a unique destination. But of course the

22304

destination may be another wormhole which instantly teleports the actor again.

22305

An infinite circle of wormholes that are connected by destinations is forbidden.

22306

22307

A wormhole can attract or repel actors in its ‘<samp>range</samp>’ with a force

22308

proportional to the ‘<samp>strength</samp>’ and the inverse of the squared distance.

22309

The force can be switched ‘<samp>ON</samp>’ and ‘<samp>OFF</samp>’ and is represented by its

22310

external ‘<samp>state</samp>’. Note that no forces are applied to actors at a distance

22311

smaller than 0.05 grids to avoid extraordinary large forces.

22312

22313

Rubberbands bound to teleported actors are cut by default. The attribute

22314

‘<samp>scissor</samp>’ allows you to control the cutting behaviour.

22315

22316

After teleporting an actor, the wormhole’s teleporting ability may be switched

22317

off for a short latency period given by ‘<samp>interval</samp>’. A latency separates

22318

actors traveling through a wormhole and avoids overlapping actors at the

22319

destination.

22320

22321

But the teleporting feature of a wormhole is not limited to actors. A water

22322

flood will spread through a wormhole, too. Of course all actor related

22323

attributes described above have no influence on the flood. Just the

22324

‘<samp>destination</samp>’ is important as explained in details in <a href="#Flood-Spreading">Flood Spreading</a>.

22325

22326

22327

<dt> Attributes:</dt>

22328

22329

<dt> state,   values: <code>ON</code>, <code>OFF</code>;   default: <code>ON</code>   See section <a href="#state">state</a></dt>

22330

<dd>The current force state - ‘<samp>ON</samp>’ for a force applying wormholes, ‘<samp>OFF</samp>’

22331

for force neutral wormholes.

22332

</dd>

22333

<dt> destination,   values: tokens or position;   default: <code>nil</code>   See section <a href="#destination">destination</a></dt>

22334

<dd>The destination of the teleport given by an object or a position.

22335

</dd>

22336

<dt> range   values: float number greater or equal 0;   default: <code>10.0</code>   See section <a href="#WormholeRange">WormholeRange</a></dt>

22337

<dd>The distance up to which the wormhole applies forces to actors.

22338

</dd>

22339

<dt> strength   values: float number;   default: <code>+30.0</code>   See section <a href="#WormholeStrength">WormholeStrength</a></dt>

22340

<dd>A scalar factor for the wormhole force. Positive numbers are attracting forces

22341

where as negative numbers are repelling forces.

22342

</dd>

22343

<dt> scissor,   values: <code>true</code>, <code>false</code>;   default: <code>true</code></dt>

22344

<dd>Rubberband cutting behaviour on teleporting.

22345

</dd>

22346

<dt> interval   values: float number greater or equal 0;   default: <code>0.0</code></dt>

22347

<dd>The latency time after a teleport during which no further teleports take place.

22348

</dd>

22349

<dt> freezable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#freezable">freezable</a></dt>

22350

<dt> liftable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#liftable">liftable</a></dt>

22351

<dt> portable,   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: <code>read only</code>   See section <a href="#portable">portable</a></dt>

22352

</dl>

22353

22354

</dd>

22355

<dt> Messages:</dt>

22356

22357

<dt> signal   See section <a href="#signal">signal</a></dt>

22358

<dd>A signal of value 1 switches the wormhole force on, a value of 0 switches the

22359

wormhole force off.

22360

</dd>

22361

<dt> toggle   See section <a href="#toggle">toggle</a></dt>

22362

<dd>A toggle causes a change in the wormhole force activity state.

22363

</dd>

22364

<dt> on   See section <a href="#on">on</a></dt>

22365

<dd>Switches the wormhole on.

22366

</dd>

22367

<dt> off   See section <a href="#off">off</a></dt>

22368

<dd>Switches the wormhole off.

22369

</dd>

22370

</dl>

22371

22372

</dd>

22373

<dt> Action: none</dt>

22374

<dt> Variants:</dt>

22375

22376

<dt> <img src="images/it_wormhole.png" alt="images/it_wormhole"> it_wormhole: state = <code>ON</code>.

22377

</dt>

22378

<dt> <img src="images/it_wormhole.png" alt="images/it_wormhole"> it_wormhole_on: state = <code>ON</code>.

22379

</dt>

22380

<dt> <img src="images/fl_white.png" alt="images/fl_white"> it_wormhole_off: state <code>OFF</code>.

22381

</dt>

22382

</dl>

22383

</dd>

22384

</dl>

22385

22386

22387

22388

22389

22390

22391

22392

22393

22394

22395

22396

22397

22398

22399

22400

22401

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

22402

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

22403

22404

</tr></table>

22405

22406

<h1 class="chapter">9. Stone Objects</h1>

22407

22408

22409

<tr><td align="left" valign="top"><a href="#Stone-Overview">9.1 Stone Overview</a></td><td>  </td><td align="left" valign="top">

22410

</td></tr>

22411

<tr><td align="left" valign="top"><a href="#Stone-Attributes">9.2 Stone Attributes</a></td><td>  </td><td align="left" valign="top">

22412

</td></tr>

22413

<tr><td align="left" valign="top"><a href="#Standard-Stones">9.3 Standard Stones</a></td><td>  </td><td align="left" valign="top">

22414

</td></tr>

22415

<tr><td align="left" valign="top"><a href="#Cluster-Stones">9.4 Cluster Stones</a></td><td>  </td><td align="left" valign="top">

22416

</td></tr>

22417

<tr><td align="left" valign="top"><a href="#Special-Stones">9.5 Special Stones</a></td><td>  </td><td align="left" valign="top">

22418

</td></tr>

22419

<tr><td align="left" valign="top"><a href="#Stone-Feature-Summaries">9.6 Stone Feature Summaries</a></td><td>  </td><td align="left" valign="top"> Tables of transparent, breakable, ... stones

22420

</td></tr>

22421

</table>

22422

22423

22424

22425

22426

22427

22428

22429

22430

22431

22432

22433

22434

22435

22436

22437

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

22438

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

22439

22440

</tr></table>

22441

22442

<h2 class="section">9.1 Stone Overview</h2>

22443

22444

<table>

22445

<tr><td width="8%"><img src="images/st_actorimpulse.png" alt="images/st_actorimpulse"></td><td width="25%"><a href="#st_005factorimpulse">st_actorimpulse</a></td><td width="8%"><img src="images/st_ancient.png" alt="images/st_ancient"></td><td width="25%"><a href="#st_005fancient">st_ancient</a></td><td width="9%"><img src="images/st_barrier.png" alt="images/st_barrier"></td><td width="25%"><a href="#st_005fbarrier">st_barrier</a></td></tr>

22446

<tr><td width="8%"><img src="images/st_beads.png" alt="images/st_beads"></td><td width="25%"><a href="#st_005fbeads">st_beads</a></td><td width="8%"><img src="images/st_blocker.png" alt="images/st_blocker"></td><td width="25%"><a href="#st_005fblocker">st_blocker</a></td><td width="9%"><img src="images/st_boulder.png" alt="images/st_boulder"></td><td width="25%"><a href="#st_005fboulder">st_boulder</a></td></tr>

22447

<tr><td width="8%"><img src="images/st_bluegray.png" alt="images/st_bluegray"></td><td width="25%"><a href="#st_005fbluegray">st_bluegray</a> or <a href="#st_005fthief">st_thief</a></td><td width="8%"><img src="images/st_bluesand.png" alt="images/st_bluesand"></td><td width="25%"><a href="#st_005fbluesand">st_bluesand</a></td><td width="9%"><img src="images/st_blur_cross.png" alt="images/st_blur_cross"></td><td width="25%"><a href="#st_005fblur">st_blur</a>_cross</td></tr>

22448

<tr><td width="8%"><img src="images/st_blur_straight.png" alt="images/st_blur_straight"></td><td width="25%"><a href="#st_005fblur">st_blur</a>_straight</td><td width="8%"><img src="images/st_box_hay.png" alt="images/st_box_hay"></td><td width="25%"><a href="#st_005fbox">st_box</a>_hay</td><td width="9%"><img src="images/st_box_rock.png" alt="images/st_box_rock"></td><td width="25%"><a href="#st_005fbox">st_box</a>_rock</td></tr>

22449

<tr><td width="8%"><img src="images/st_box_wood.png" alt="images/st_box_wood"></td><td width="25%"><a href="#st_005fbox">st_box</a>_wood</td><td width="8%"><img src="images/st_brake.png" alt="images/st_brake"></td><td width="25%"><a href="#st_005fbrake">st_brake</a></td><td width="9%"><img src="images/st_break_black.png" alt="images/st_break_black"></td><td width="25%"><a href="#st_005fbreak">st_break</a>_black</td></tr>

22450

<tr><td width="8%"><img src="images/st_break_boulder.png" alt="images/st_break_boulder"></td><td width="25%"><a href="#st_005fbreak">st_break</a>_boulder</td><td width="8%"><img src="images/st_break_bug.png" alt="images/st_break_bug"></td><td width="25%"><a href="#st_005fbreak">st_break</a>_bug</td><td width="9%"><img src="images/st_break_oxydc.png" alt="images/st_break_oxydc"></td><td width="25%"><a href="#st_005fbreak">st_break</a>_oxydc</td></tr>

22451

<tr><td width="8%"><img src="images/st_break_plain.png" alt="images/st_break_plain"></td><td width="25%"><a href="#st_005fbreak">st_break</a>_plain</td><td width="8%"><img src="images/st_break_white.png" alt="images/st_break_white"></td><td width="25%"><a href="#st_005fbreak">st_break</a>_white</td><td width="9%"><img src="images/st_brick.png" alt="images/st_brick"></td><td width="25%"><a href="#st_005fbrick">st_brick</a></td></tr>

22452

<tr><td width="8%"><img src="images/st_brownie.png" alt="images/st_brownie"></td><td width="25%"><a href="#st_005fbrownie">st_brownie</a></td><td width="8%"><img src="images/st_brownmarble.png" alt="images/st_brownmarble"></td><td width="25%"><a href="#st_005fbrownmarble">st_brownmarble</a></td><td width="9%"><img src="images/st_brownpyramid.png" alt="images/st_brownpyramid"></td><td width="25%"><a href="#st_005fbrownpyramid">st_brownpyramid</a></td></tr>

22453

<tr><td width="8%"><img src="images/st_camouflage.png" alt="images/st_camouflage"></td><td width="25%"><a href="#st_005fcamouflage">st_camouflage</a></td><td width="8%"><img src="images/st_charge_minus.png" alt="images/st_charge_minus"></td><td width="25%"><a href="#st_005fcharge">st_charge</a>_minus</td><td width="9%"><img src="images/st_charge_plus.png" alt="images/st_charge_plus"></td><td width="25%"><a href="#st_005fcharge">st_charge</a>_plus</td></tr>

22454

<tr><td width="8%"><img src="images/st_charge_zero.png" alt="images/st_charge_zero"></td><td width="25%"><a href="#st_005fcharge">st_charge</a>_zero</td><td width="8%"><img src="images/st_chess_black.png" alt="images/st_chess_black"></td><td width="25%"><a href="#st_005fchess">st_chess</a>_black</td><td width="9%"><img src="images/st_chess_white.png" alt="images/st_chess_white"></td><td width="25%"><a href="#st_005fchess">st_chess</a>_white</td></tr>

22455

<tr><td width="8%"><img src="images/st_coinslot.png" alt="images/st_coinslot"></td><td width="25%"><a href="#st_005fcoinslot">st_coinslot</a></td><td width="8%"><img src="images/st_concrete.png" alt="images/st_concrete"></td><td width="25%"><a href="#st_005fconcrete">st_concrete</a></td><td width="9%"><img src="images/st_darkglass.png" alt="images/st_darkglass"></td><td width="25%"><a href="#st_005fdarkglass">st_darkglass</a></td></tr>

22456

<tr><td width="8%"><img src="images/st_darkgray.png" alt="images/st_darkgray"></td><td width="25%"><a href="#st_005fdarkgray">st_darkgray</a></td><td width="8%"><img src="images/st_death.png" alt="images/st_death"></td><td width="25%"><a href="#st_005fdeath">st_death</a></td><td width="9%"><img src="images/st_disco.png" alt="images/st_disco"></td><td width="25%"><a href="#st_005fdisco">st_disco</a>_light</td></tr>

22457

<tr><td width="8%"><img src="images/st_disco_2.png" alt="images/st_disco_2"></td><td width="25%"><a href="#st_005fdisco">st_disco</a>_medium</td><td width="8%"><img src="images/st_disco_3.png" alt="images/st_disco_3"></td><td width="25%"><a href="#st_005fdisco">st_disco</a>_dark</td><td width="9%"><img src="images/st_door_d_ew_g.png" alt="images/st_door_d_ew_g"></td><td width="25%"><a href="#st_005fdoor">st_door</a>_d (ew)</td></tr>

22458

<tr><td width="8%"><img src="images/st_door_d_ns_7.png" alt="images/st_door_d_ns_7"></td><td width="25%"><a href="#st_005fdoor">st_door</a>_d (ns)</td><td width="8%"><img src="images/st_dispenser_bombblack.png" alt="images/st_dispenser_bombblack"></td><td width="25%"><a href="#st_005fdispenser">st_dispenser</a>_bombblack</td><td width="9%"><img src="images/st_dispenser_bombwhite.png" alt="images/st_dispenser_bombwhite"></td><td width="25%"><a href="#st_005fdispenser">st_dispenser</a>_bombwhite</td></tr>

22459

<tr><td width="8%"><img src="images/st_dispenser_dynamite.png" alt="images/st_dispenser_dynamite"></td><td width="25%"><a href="#st_005fdispenser">st_dispenser</a>_dynamite</td><td width="8%"><img src="images/st_dispenser_extralife.png" alt="images/st_dispenser_extralife"></td><td width="25%"><a href="#st_005fdispenser">st_dispenser</a>_extralife</td><td width="9%"><img src="images/st_oxydc_open.png" alt="images/st_oxydc_open"></td><td width="25%"><a href="#st_005ffake">st_fake</a>_oxydc (open)</td></tr>

22460

<tr><td width="8%"><img src="images/st_flash.png" alt="images/st_flash"></td><td width="25%"><a href="#st_005fflash">st_flash</a></td><td width="8%"><img src="images/st_flat.png" alt="images/st_flat"></td><td width="25%"><a href="#st_005fflat">st_flat</a></td><td width="9%"><img src="images/st_floppy_off.png" alt="images/st_floppy_off"></td><td width="25%"><a href="#st_005ffloppy">st_floppy</a>_off</td></tr>

22461

<tr><td width="8%"><img src="images/st_floppy_on.png" alt="images/st_floppy_on"></td><td width="25%"><a href="#st_005ffloppy">st_floppy</a>_on</td><td width="8%"><img src="images/st_fourswitch.png" alt="images/st_fourswitch"></td><td width="25%"><a href="#st_005ffourswitch">st_fourswitch</a></td><td width="9%"><img src="images/st_granite.png" alt="images/st_granite"></td><td width="25%"><a href="#st_005fgranite">st_granite</a></td></tr>

22462

<tr><td width="8%"><img src="images/st_grate_cross.png" alt="images/st_grate_cross"></td><td width="25%"><a href="#st_005fgrate">st_grate</a>_cross</td><td width="8%"><img src="images/st_grate_framed.png" alt="images/st_grate_framed"></td><td width="25%"><a href="#st_005fgrate">st_grate</a>_framed</td><td width="9%"><img src="images/st_greenbrown.png" alt="images/st_greenbrown"></td><td width="25%"><a href="#st_005fgreenbrown">st_greenbrown</a></td></tr>

22463

<tr><td width="8%"><img src="images/st_greengray.png" alt="images/st_greengray"></td><td width="25%"><a href="#st_005fgreengray">st_greengray</a></td><td width="8%"><img src="images/st_ice.png" alt="images/st_ice"></td><td width="25%"><a href="#st_005fice">st_ice</a></td><td width="9%"></td><td width="25%"><a href="#st_005finvisible">st_invisible</a> or <a href="#st_005fghost">st_ghost</a></td></tr>

22464

<tr><td width="8%"><img src="images/st_jamb_black.png" alt="images/st_jamb_black"></td><td width="25%"><a href="#st_005fjamb">st_jamb</a>_black</td><td width="8%"><img src="images/st_jamb_white.png" alt="images/st_jamb_white"></td><td width="25%"><a href="#st_005fjamb">st_jamb</a>_white</td><td width="9%"><img src="images/st_key_off.png" alt="images/st_key_off"></td><td width="25%"><a href="#st_005fkey">st_key</a>_off</td></tr>

22465

<tr><td width="8%"><img src="images/st_key_on.png" alt="images/st_key_on"></td><td width="25%"><a href="#st_005fkey">st_key</a>_on</td><td width="8%"><img src="images/st_knight.png" alt="images/st_knight"></td><td width="25%"><a href="#st_005fknight">st_knight</a></td><td width="9%"><img src="images/st_laser_d.png" alt="images/st_laser_d"></td><td width="25%"><a href="#st_005flaser">st_laser</a></td></tr>

22466

<tr><td width="8%"><img src="images/st_lightglass.png" alt="images/st_lightglass"></td><td width="25%"><a href="#st_005flightglass">st_lightglass</a></td><td width="8%"><img src="images/st_lightpassenger.png" alt="images/st_lightpassenger"></td><td width="25%"><a href="#st_005flightpassenger">st_lightpassenger</a></td><td width="9%"><img src="images/st_mail.png" alt="images/st_mail"></td><td width="25%"><a href="#st_005fmail">st_mail</a></td></tr>

22467

<tr><td width="8%"><img src="images/st_metal.png" alt="images/st_metal"></td><td width="25%"><a href="#st_005fmetal">st_metal</a></td><td width="8%"><img src="images/st_mirror_static_2.png" alt="images/st_mirror_static_2"></td><td width="25%"><a href="#st_005fmirror">st_mirror</a>_triangle</td><td width="9%"><img src="images/st_mirror_static_b2.png" alt="images/st_mirror_static_b2"></td><td width="25%"><a href="#st_005fmirror">st_mirror</a>_triangle</td></tr>

22468

<tr><td width="8%"><img src="images/st_mirror_static_c2.png" alt="images/st_mirror_static_c2"></td><td width="25%"><a href="#st_005fmirror">st_mirror</a>_slab</td><td width="8%"><img src="images/st_mirror_static_d2.png" alt="images/st_mirror_static_d2"></td><td width="25%"><a href="#st_005fmirror">st_mirror</a>_slab</td><td width="9%"><img src="images/st_mirror_static_e2.png" alt="images/st_mirror_static_e2"></td><td width="25%"><a href="#st_005fmirror">st_mirror</a>_sheets</td></tr>

22469

<tr><td width="8%"><img src="images/st_monoflop.png" alt="images/st_monoflop"></td><td width="25%"><a href="#st_005fmonoflop">st_monoflop</a></td><td width="8%"><img src="images/st_monoflop_2.png" alt="images/st_monoflop_2"></td><td width="25%"><a href="#st_005fmonoflop">st_monoflop</a></td><td width="9%"><img src="images/st_oneway.png" alt="images/st_oneway"></td><td width="25%"><a href="#st_005foneway">st_oneway</a></td></tr>

22470

<tr><td width="8%"><img src="images/st_oneway_b.png" alt="images/st_oneway_b"></td><td width="25%"><a href="#st_005foneway">st_oneway</a>_black</td><td width="8%"><img src="images/st_oneway_c.png" alt="images/st_oneway_c"></td><td width="25%"><a href="#st_005foneway">st_oneway</a>_white</td><td width="9%"><img src="images/st_oxyda.png" alt="images/st_oxyda"></td><td width="25%"><a href="#st_005foxyd">st_oxyd</a>_a</td></tr>

22471

<tr><td width="8%"><img src="images/st_oxydb.png" alt="images/st_oxydb"></td><td width="25%"><a href="#st_005foxyd">st_oxyd</a>_b or <a href="#st_005fquake">st_quake</a> or <a href="#st_005flaserswitch">st_laserswitch</a></td><td width="8%"><img src="images/st_oxydc.png" alt="images/st_oxydc"></td><td width="25%"><a href="#st_005foxyd">st_oxyd</a>_c</td><td width="9%"><img src="images/st_oxydd.png" alt="images/st_oxydd"></td><td width="25%"><a href="#st_005foxyd">st_oxyd</a>_d</td></tr>

22472

<tr><td width="8%"><img src="images/st_oxyde.png" alt="images/st_oxyde"></td><td width="25%"><a href="#st_005foxyd">st_oxyd</a>_e</td><td width="8%"><img src="images/st_panel.png" alt="images/st_panel"></td><td width="25%"><a href="#st_005fpanel">st_panel</a></td><td width="9%"><img src="images/st_passage_black_square.png" alt="images/st_passage_black_square"></td><td width="25%"><a href="#st_005fpassage">st_passage</a>_black</td></tr>

22473

<tr><td width="8%"><img src="images/st_passage_black_slash.png" alt="images/st_passage_black_slash"></td><td width="25%"><a href="#st_005fpassage">st_passage</a>_black</td><td width="8%"><img src="images/st_passage_black_cross.png" alt="images/st_passage_black_cross"></td><td width="25%"><a href="#st_005fpassage">st_passage</a>_black</td><td width="9%"><img src="images/st_passage_black_frame.png" alt="images/st_passage_black_frame"></td><td width="25%"><a href="#st_005fpassage">st_passage</a>_black</td></tr>

22474

<tr><td width="8%"><img src="images/st_passage_white_square.png" alt="images/st_passage_white_square"></td><td width="25%"><a href="#st_005fpassage">st_passage</a>_white</td><td width="8%"><img src="images/st_passage_white_slash.png" alt="images/st_passage_white_slash"></td><td width="25%"><a href="#st_005fpassage">st_passage</a>_white</td><td width="9%"><img src="images/st_passage_white_cross.png" alt="images/st_passage_white_cross"></td><td width="25%"><a href="#st_005fpassage">st_passage</a>_white</td></tr>

22475

<tr><td width="8%"><img src="images/st_passage_white_frame.png" alt="images/st_passage_white_frame"></td><td width="25%"><a href="#st_005fpassage">st_passage</a>_white</td><td width="8%"><img src="images/st_pinkbumps.png" alt="images/st_pinkbumps"></td><td width="25%"><a href="#st_005fpinkbumps">st_pinkbumps</a></td><td width="9%"><img src="images/st_plaster.png" alt="images/st_plaster"></td><td width="25%"><a href="#st_005fplaster">st_plaster</a></td></tr>

22476

<tr><td width="8%"><img src="images/st_plop_slate.png" alt="images/st_plop_slate"></td><td width="25%"><a href="#st_005fplop">st_plop</a>_slate</td><td width="8%"><img src="images/st_portal_horse.png" alt="images/st_portal_horse"></td><td width="25%"><a href="#st_005fportal">st_portal</a></td><td width="9%"><img src="images/st_pull.png" alt="images/st_pull"></td><td width="25%"><a href="#st_005fpull">st_pull</a></td></tr>

22477

<tr><td width="8%"><img src="images/st_purplegray.png" alt="images/st_purplegray"></td><td width="25%"><a href="#st_005fpurplegray">st_purplegray</a></td><td width="8%"><img src="images/st_purplemarble.png" alt="images/st_purplemarble"></td><td width="25%"><a href="#st_005fpurplemarble">st_purplemarble</a></td><td width="9%"><img src="images/st_puzzle_blue_3.png" alt="images/st_puzzle_blue_3"></td><td width="25%"><a href="#st_005fpuzzle">st_puzzle</a>_blue or <a href="#st_005fturnstilearm">st_turnstilearm</a>_n</td></tr>

22478

<tr><td width="8%"><img src="images/st_puzzle_blue_d3.png" alt="images/st_puzzle_blue_d3"></td><td width="25%"><a href="#st_005fpuzzle">st_puzzle</a>_blue</td><td width="8%"><img src="images/st_puzzle_blue_hollow_d3.png" alt="images/st_puzzle_blue_hollow_d3"></td><td width="25%"><a href="#st_005fpuzzle">st_puzzle</a>_blue</td><td width="9%"><img src="images/st_puzzle_yellow_d3.png" alt="images/st_puzzle_yellow_d3"></td><td width="25%"><a href="#st_005fpuzzle">st_puzzle</a>_yellow</td></tr>

22479

<tr><td width="8%"><img src="images/st_puzzle_yellow_hollow_d3.png" alt="images/st_puzzle_yellow_hollow_d3"></td><td width="25%"><a href="#st_005fpuzzle">st_puzzle</a>_yellow</td><td width="8%"><img src="images/st_rawglass.png" alt="images/st_rawglass"></td><td width="25%"><a href="#st_005frawglass">st_rawglass</a></td><td width="9%"><img src="images/st_rawglass_quad.png" alt="images/st_rawglass_quad"></td><td width="25%"><a href="#st_005frawglass">st_rawglass</a>_quad</td></tr>

22480

<tr><td width="8%"><img src="images/st_redbrown.png" alt="images/st_redbrown"></td><td width="25%"><a href="#st_005fredbrown">st_redbrown</a></td><td width="8%"><img src="images/st_redfiber.png" alt="images/st_redfiber"></td><td width="25%"><a href="#st_005fredfiber">st_redfiber</a></td><td width="9%"><img src="images/st_redmarble.png" alt="images/st_redmarble"></td><td width="25%"><a href="#st_005fredmarble">st_redmarble</a></td></tr>

22481

<tr><td width="8%"><img src="images/st_redrock.png" alt="images/st_redrock"></td><td width="25%"><a href="#st_005fredrock">st_redrock</a></td><td width="8%"><img src="images/st_rotator_ccw.png" alt="images/st_rotator_ccw"></td><td width="25%"><a href="#st_005frotator">st_rotator</a>_ccw</td><td width="9%"><img src="images/st_rotator_cw.png" alt="images/st_rotator_cw"></td><td width="25%"><a href="#st_005frotator">st_rotator</a>_cw</td></tr>

22482

<tr><td width="8%"><img src="images/st_rubberband.png" alt="images/st_rubberband"></td><td width="25%"><a href="#st_005frubberband">st_rubberband</a></td><td width="8%"><img src="images/st_scissors.png" alt="images/st_scissors"></td><td width="25%"><a href="#st_005fscissors">st_scissors</a></td><td width="9%"><img src="images/st_shogun.png" alt="images/st_shogun"></td><td width="25%"><a href="#st_005fshogun">st_shogun</a>_s</td></tr>

22483

<tr><td width="8%"><img src="images/st_shogun_2.png" alt="images/st_shogun_2"></td><td width="25%"><a href="#st_005fshogun">st_shogun</a>_m</td><td width="8%"><img src="images/st_shogun_4.png" alt="images/st_shogun_4"></td><td width="25%"><a href="#st_005fshogun">st_shogun</a>_l</td><td width="9%"><img src="images/st_spitter_idle.png" alt="images/st_spitter_idle"></td><td width="25%"><a href="#st_005fspitter">st_spitter</a></td></tr>

22484

<tr><td width="8%"><img src="images/st_stoneimpulse.png" alt="images/st_stoneimpulse"></td><td width="25%"><a href="#st_005fstoneimpulse">st_stoneimpulse</a></td><td width="8%"><img src="images/st_stoneimpulse_hollow.png" alt="images/st_stoneimpulse_hollow"></td><td width="25%"><a href="#st_005fstoneimpulse">st_stoneimpulse</a>_hollow</td><td width="9%"><img src="images/st_surprise.png" alt="images/st_surprise"></td><td width="25%"><a href="#st_005fsurprise">st_surprise</a></td></tr>

22485

<tr><td width="8%"><img src="images/st_swap.png" alt="images/st_swap"></td><td width="25%"><a href="#st_005fswap">st_swap</a></td><td width="8%"><img src="images/st_switch.png" alt="images/st_switch"></td><td width="25%"><a href="#st_005fswitch">st_switch</a></td><td width="9%"><img src="images/st_switch_black.png" alt="images/st_switch_black"></td><td width="25%"><a href="#st_005fswitch">st_switch</a>_black</td></tr>

22486

<tr><td width="8%"><img src="images/st_switch_white.png" alt="images/st_switch_white"></td><td width="25%"><a href="#st_005fswitch">st_switch</a>_white</td><td width="8%"><img src="images/st_thief.png" alt="images/st_thief"></td><td width="25%"><a href="#st_005fthief">st_thief</a></td><td width="9%"><img src="images/st_thief_capture.png" alt="images/st_thief_capture"></td><td width="25%"><a href="#st_005fthief">st_thief</a></td></tr>

22487

<tr><td width="8%"><img src="images/st_thief_drunken.png" alt="images/st_thief_drunken"></td><td width="25%"><a href="#st_005fthief">st_thief</a></td><td width="8%"><img src="images/st_tigris.png" alt="images/st_tigris"></td><td width="25%"><a href="#st_005ftigris">st_tigris</a></td><td width="9%"><img src="images/st_timer_3.png" alt="images/st_timer_3"></td><td width="25%"><a href="#st_005ftimer">st_timer</a></td></tr>

22488

<tr><td width="8%"><img src="images/st_timer.png" alt="images/st_timer"></td><td width="25%"><a href="#st_005ftimer">st_timer</a></td><td width="8%"><img src="images/st_turnstile.png" alt="images/st_turnstile"></td><td width="25%"><a href="#st_005fturnstile">st_turnstile</a></td><td width="9%"><img src="images/st_turnstile_green.png" alt="images/st_turnstile_green"></td><td width="25%"><a href="#st_005fturnstile">st_turnstile</a>_green</td></tr>

22489

<tr><td width="8%"><img src="images/st_window_blue_3.png" alt="images/st_window_blue_3"></td><td width="25%"><a href="#st_005fwindow">st_window</a></td><td width="8%"><img src="images/st_window_green_3.png" alt="images/st_window_green_3"></td><td width="25%"><a href="#st_005fwindow">st_window</a></td><td width="9%"><img src="images/st_woven.png" alt="images/st_woven"></td><td width="25%"><a href="#st_005fwoven">st_woven</a></td></tr>

22490

<tr><td width="8%"><img src="images/st_yellow.png" alt="images/st_yellow"></td><td width="25%"><a href="#st_005fyellow">st_yellow</a></td><td width="8%"><img src="images/st_yinyang.png" alt="images/st_yinyang"></td><td width="25%"><a href="#st_005fyinyang">st_yinyang</a></td><td width="9%"><img src="images/st_yinyang_inactive.png" alt="images/st_yinyang_inactive"></td><td width="25%"><a href="#st_005fyinyang">st_yinyang</a>_inactive</td></tr>

22491

</table>

22492

22493

22494

22495

22496

22497

22498

22499

22500

22501

22502

22503

22504

22505

22506

22507

22508

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

22509

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

22510

22511

</tr></table>

22512

22513

<h2 class="section">9.2 Stone Attributes</h2>

22514

22515

22516

<tr><td align="left" valign="top"><a href="#breakable">9.2.1 breakable</a></td><td>  </td><td align="left" valign="top"> -

22517

</td></tr>

22518

<tr><td align="left" valign="top"><a href="#freeze_005fcheck-_0028stone_0029">9.2.2 freeze_check (stone)</a></td><td>  </td><td align="left" valign="top"> Freeze Checking

22519

</td></tr>

22520

<tr><td align="left" valign="top"><a href="#hit_005f_002a">9.2.3 hit_*</a></td><td>  </td><td align="left" valign="top"> -

22521

</td></tr>

22522

<tr><td align="left" valign="top"><a href="#hollow">9.2.4 hollow</a></td><td>  </td><td align="left" valign="top"> -

22523

</td></tr>

22524

<tr><td align="left" valign="top"><a href="#hovering">9.2.5 hovering</a></td><td>  </td><td align="left" valign="top"> -

22525

</td></tr>

22526

<tr><td align="left" valign="top"><a href="#movable">9.2.6 movable</a></td><td>  </td><td align="left" valign="top"> -

22527

</td></tr>

22528

<tr><td align="left" valign="top"><a href="#transparent">9.2.7 transparent</a></td><td>  </td><td align="left" valign="top"> -

22529

</td></tr>

22530

</table>

22531

22532

22533

22534

22535

22536

22537

22538

22539

22540

22541

22542

22543

22544

22545

22546

22547

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

22548

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

22549

22550

</tr></table>

22551

22552

<h3 class="subsection">9.2.1 breakable</h3>

22553

22554

22555

22556

<dt> Type:   boolean</dt>

22557

<dt> Values:   <code>false</code>, <code>true</code></dt>

22558

<dt> Default:   <code>false</code></dt>

22559

<dt> Access:   read/write</dt>

22560

</dl>

22561

22562

22563

22564

22565

22566

22567

22568

22569

22570

22571

22572

22573

22574

22575

22576

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

22577

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

22578

22579

</tr></table>

22580

22581

<h3 class="subsection">9.2.2 freeze_check (stone)</h3>

22582

22583

If <code>true</code>, allows for <a href="#Freeze-Checking">Freeze Checking</a> for this stone. Note that

22584

Freeze Checking only works on those floors that have additionally set

22585

<code>freeze_check = true</code> on their own, see <a href="#freeze_005fcheck-_0028floor_0029">freeze_check (floor)</a>.

22586

22587

22588

<dt> Type:   boolean</dt>

22589

<dt> Values:   <code>false</code>, <code>true</code></dt>

22590

<dt> Default:   <code>false</code></dt>

22591

<dt> Access:   read/write</dt>

22592

</dl>

22593

22594

22595

22596

22597

22598

22599

22600

22601

22602

22603

22604

22605

22606

22607

22608

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

22609

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

22610

22611

</tr></table>

22612

22613

22614

22615

A set of attributes that allow you to distort hit forces. Objects like

22616

<a href="#st_005fflash">st_flash</a>, <a href="#st_005fspitter">st_spitter</a> and <a href="#st_005factorimpulse">st_actorimpulse</a> apply forces that

22617

are either based on the hit velocity or the position.

22618

22619

By usage of a simple ‘<samp>hit_strength</samp>’ factor you can increase, decrease or

22620

invert the default factor. Note that you must not set this attribute, if you

22621

want to use the default.

22622

22623

By setting the four attributes ‘<samp>hit_distortion_xx</samp>’, ‘<samp>hit_distortion_xy</samp>’,

22624

‘<samp>hit_distortion_yx</samp>’ and ‘<samp>hit_distortion_yy</samp>’ you can describe a

22625

matrix to set up a new direction. These attributes default to 1, 0, 0, 1.

22626

A 90 degree clockwise turn is described by 0, 1, -1, 0.

22627

22628

22629

<dt> Type:   number</dt>

22630

<dt> Values:   ?</dt>

22631

<dt> Default:   factor - <code>nil</code>, xx, yy - <code>1</code>, xy, yx - <code>0</code></dt>

22632

<dd>By default no hit factor is applied. The hit matrix is the neutral one.

22633

</dd>

22634

<dt> Access:   read/write</dt>

22635

<dt> Support:   by some stones</dt>

22636

</dl>

22637

22638

22639

22640

22641

22642

22643

22644

22645

22646

22647

22648

22649

22650

22651

22652

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

22653

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

22654

22655

</tr></table>

22656

22657

<h3 class="subsection">9.2.4 hollow</h3>

22658

22659

22660

22661

<dt> Type:   boolean</dt>

22662

<dt> Values:   <code>false</code>, <code>true</code></dt>

22663

<dt> Default:   <code>false</code></dt>

22664

<dt> Access:   read/write</dt>

22665

</dl>

22666

22667

22668

22669

22670

22671

22672

22673

22674

22675

22676

22677

22678

22679

22680

22681

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

22682

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

22683

22684

</tr></table>

22685

22686

<h3 class="subsection">9.2.5 hovering</h3>

22687

22688

22689

22690

<dt> Type:   boolean</dt>

22691

<dt> Values:   <code>false</code>, <code>true</code></dt>

22692

<dt> Default:   <code>false</code></dt>

22693

<dt> Access:   read/write</dt>

22694

</dl>

22695

22696

22697

22698

22699

22700

22701

22702

22703

22704

22705

22706

22707

22708

22709

22710

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

22711

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

22712

22713

</tr></table>

22714

22715

<h3 class="subsection">9.2.6 movable</h3>

22716

22717

An attribute that describes if a stone is movable by actor impulses. It is

22718

supported by all stones.

22719

22720

Note that this attribute is not listed in the individual stone description

22721

if the stone is generally not movable.

22722

22723

22724

22725

<dt> Values:   <code>true</code>, <code>false</code></dt>

22726

<dt> Default:   usually <code>false</code></dt>

22727

<dd>If a stone exists only in a movable variant this attribute will default to

22728

‘<samp>true</samp>’.

22729

</dd>

22730

<dt> Access:   read/sometimes write</dt>

22731

<dd>This attribute is only writable for objects that exist in both variations.

22732

</dd>

22733

<dt> Support:   by all stones</dt>

22734

</dl>

22735

22736

22737

22738

22739

22740

22741

22742

22743

22744

22745

22746

22747

22748

22749

22750

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

22751

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

22752

22753

</tr></table>

22754

22755

<h3 class="subsection">9.2.7 transparent</h3>

22756

22757

22758

22759

<dt> Type:   boolean</dt>

22760

<dt> Values:   <code>false</code>, <code>true</code></dt>

22761

<dt> Default:   <code>false</code></dt>

22762

<dt> Access:   read/write</dt>

22763

</dl>

22764

22765

22766

22767

22768

22769

22770

22771

22772

22773

22774

22775

22776

22777

22778

22779

22780

22781

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

22782

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

22783

22784

</tr></table>

22785

22786

<h2 class="section">9.3 Standard Stones</h2>

22787

22788

A standard stone is a passive wall stone. It might exist in a hollow or

22789

movable variant but provides no additional features.

22790

22791

22792

<tr><td align="left" valign="top"><a href="#st_005fancient">9.3.1 st_ancient</a></td><td>  </td><td align="left" valign="top"> rough green rock

22793

</td></tr>

22794

<tr><td align="left" valign="top"><a href="#st_005fbluegray">9.3.2 st_bluegray</a></td><td>  </td><td align="left" valign="top"> light blue gray stone

22795

</td></tr>

22796

<tr><td align="left" valign="top"><a href="#st_005fbrownie">9.3.3 st_brownie</a></td><td>  </td><td align="left" valign="top"> golden, hay stack like stone

22797

</td></tr>

22798

<tr><td align="left" valign="top"><a href="#st_005fbrownmarble">9.3.4 st_brownmarble</a></td><td>  </td><td align="left" valign="top"> brown gray marble

22799

</td></tr>

22800

<tr><td align="left" valign="top"><a href="#st_005fcamouflage">9.3.5 st_camouflage</a></td><td>  </td><td align="left" valign="top"> military green camouflage stone

22801

</td></tr>

22802

<tr><td align="left" valign="top"><a href="#st_005fconcrete">9.3.6 st_concrete</a></td><td>  </td><td align="left" valign="top"> polished light gray stone

22803

</td></tr>

22804

<tr><td align="left" valign="top"><a href="#st_005fdarkgray">9.3.7 st_darkgray</a></td><td>  </td><td align="left" valign="top"> dark gray rock

22805

</td></tr>

22806

<tr><td align="left" valign="top"><a href="#st_005fgranite">9.3.8 st_granite</a></td><td>  </td><td align="left" valign="top"> light gray rock

22807

</td></tr>

22808

<tr><td align="left" valign="top"><a href="#st_005fgreengray">9.3.9 st_greengray</a></td><td>  </td><td align="left" valign="top"> light green gray rock

22809

</td></tr>

22810

<tr><td align="left" valign="top"><a href="#st_005finvisible">9.3.10 st_invisible</a></td><td>  </td><td align="left" valign="top"> invisible stone

22811

</td></tr>

22812

<tr><td align="left" valign="top"><a href="#st_005fmetal">9.3.11 st_metal</a></td><td>  </td><td align="left" valign="top"> metal stone

22813

</td></tr>

22814

<tr><td align="left" valign="top"><a href="#st_005fpinkbumps">9.3.12 st_pinkbumps</a></td><td>  </td><td align="left" valign="top"> pink stone with heavy bumps

22815

</td></tr>

22816

<tr><td align="left" valign="top"><a href="#st_005fpurplegray">9.3.13 st_purplegray</a></td><td>  </td><td align="left" valign="top"> dark purple gray rock

22817

</td></tr>

22818

<tr><td align="left" valign="top"><a href="#st_005fpurplemarble">9.3.14 st_purplemarble</a></td><td>  </td><td align="left" valign="top"> purple marble

22819

</td></tr>

22820

<tr><td align="left" valign="top"><a href="#st_005fredbrown">9.3.15 st_redbrown</a></td><td>  </td><td align="left" valign="top"> brown stone with light red touches

22821

</td></tr>

22822

<tr><td align="left" valign="top"><a href="#st_005fredmarble">9.3.16 st_redmarble</a></td><td>  </td><td align="left" valign="top"> red white marbled stone

22823

</td></tr>

22824

<tr><td align="left" valign="top"><a href="#st_005fredrock">9.3.17 st_redrock</a></td><td>  </td><td align="left" valign="top"> dark red rock

22825

</td></tr>

22826

<tr><td align="left" valign="top"><a href="#st_005ftigris">9.3.18 st_tigris</a></td><td>  </td><td align="left" valign="top"> red sandstone

22827

</td></tr>

22828

<tr><td align="left" valign="top"><a href="#st_005fwoven">9.3.19 st_woven</a></td><td>  </td><td align="left" valign="top"> yellow gray woven stone

22829

</td></tr>

22830

<tr><td align="left" valign="top"><a href="#st_005fyellow">9.3.20 st_yellow</a></td><td>  </td><td align="left" valign="top"> yellow stone with red green stripes

22831

</td></tr>

22832

22833

</pre></th></tr></table>

22834

22835

22836

22837

22838

22839

22840

22841

22842

22843

22844

22845

22846

22847

22848

22849

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

22850

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

22851

22852

</tr></table>

22853

22854

<h3 class="subsection">9.3.1 st_ancient</h3>

22855

22856

22857

A rough green gray rock that looks ancient.

22858

22859

22860

<dt> Variants:</dt>

22861

22862

<dt> <img src="images/st_ancient.png" alt="images/st_ancient"> st_ancient

22863

</dt>

22864

</dl>

22865

</dd>

22866

</dl>

22867

22868

22869

22870

22871

22872

22873

22874

22875

22876

22877

22878

22879

22880

22881

22882

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

22883

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

22884

22885

</tr></table>

22886

22887

<h3 class="subsection">9.3.2 st_bluegray</h3>

22888

22889

22890

A light blue gray stone that exists in all two variants. This stone is visually

22891

indistinguishable from a <a href="#st_005fthief">st_thief</a>.

22892

22893

22894

<dt> Variants:</dt>

22895

22896

<dt> <img src="images/st_bluegray.png" alt="images/st_bluegray"> st_bluegray

22897

</dt>

22898

<dt> <img src="images/st_bluegray.png" alt="images/st_bluegray"> st_bluegray_hollow

22899

</dt>

22900

</dl>

22901

</dd>

22902

</dl>

22903

22904

22905

22906

22907

22908

22909

22910

22911

22912

22913

22914

22915

22916

22917

22918

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

22919

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

22920

22921

</tr></table>

22922

22923

<h3 class="subsection">9.3.3 st_brownie</h3>

22924

22925

22926

A golden, hay stack like stone that exists just in a movable variant.

22927

22928

22929

<dt> Variants:</dt>

22930

22931

<dt> <img src="images/st_brownie.png" alt="images/st_brownie"> st_brownie

22932

</dt>

22933

</dl>

22934

</dd>

22935

</dl>

22936

22937

22938

22939

22940

22941

22942

22943

22944

22945

22946

22947

22948

22949

22950

22951

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

22952

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

22953

22954

</tr></table>

22955

22956

<h3 class="subsection">9.3.4 st_brownmarble</h3>

22957

22958

22959

A brown gray marble like stone.

22960

22961

22962

<dt> Variants:</dt>

22963

22964

<dt> <img src="images/st_brownmarble.png" alt="images/st_brownmarble"> st_brownmarble

22965

</dt>

22966

</dl>

22967

</dd>

22968

</dl>

22969

22970

22971

22972

22973

22974

22975

22976

22977

22978

22979

22980

22981

22982

22983

22984

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

22985

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

22986

22987

</tr></table>

22988

22989

<h3 class="subsection">9.3.5 st_camouflage</h3>

22990

22991

22992

A military green camouflage stone that exists in all three variants.

22993

22994

22995

<dt> Variants:</dt>

22996

22997

<dt> <img src="images/st_camouflage.png" alt="images/st_camouflage"> st_camouflage

22998

</dt>

22999

<dt> st_camouflage_hollow</dt>

23000

<dt> st_camouflage_movable</dt>

23001

</dl>

23002

</dd>

23003

</dl>

23004

23005

23006

23007

23008

23009

23010

23011

23012

23013

23014

23015

23016

23017

23018

23019

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

23020

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

23021

23022

</tr></table>

23023

23024

<h3 class="subsection">9.3.6 st_concrete</h3>

23025

23026

23027

A polished light gray stone.

23028

23029

23030

<dt> Variants:</dt>

23031

23032

<dt> <img src="images/st_concrete.png" alt="images/st_concrete"> st_concrete

23033

</dt>

23034

</dl>

23035

</dd>

23036

</dl>

23037

23038

23039

23040

23041

23042

23043

23044

23045

23046

23047

23048

23049

23050

23051

23052

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

23053

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

23054

23055

</tr></table>

23056

23057

<h3 class="subsection">9.3.7 st_darkgray</h3>

23058

23059

23060

A dark gray rock that exists in all two variants.

23061

23062

23063

<dt> Variants:</dt>

23064

23065

<dt> <img src="images/st_darkgray.png" alt="images/st_darkgray"> st_darkgray

23066

</dt>

23067

<dt> st_darkgray_hollow</dt>

23068

</dl>

23069

</dd>

23070

</dl>

23071

23072

23073

23074

23075

23076

23077

23078

23079

23080

23081

23082

23083

23084

23085

23086

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

23087

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

23088

23089

</tr></table>

23090

23091

<h3 class="subsection">9.3.8 st_granite</h3>

23092

23093

23094

A light gray rock like stone that exists in all three variants.

23095

23096

23097

<dt> Variants:</dt>

23098

23099

<dt> <img src="images/st_granite.png" alt="images/st_granite"> st_granite

23100

</dt>

23101

<dt> st_granite_hollow</dt>

23102

<dt> st_granite_movable</dt>

23103

</dl>

23104

</dd>

23105

</dl>

23106

23107

23108

23109

23110

23111

23112

23113

23114

23115

23116

23117

23118

23119

23120

23121

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

23122

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

23123

23124

</tr></table>

23125

23126

<h3 class="subsection">9.3.9 st_greengray</h3>

23127

23128

23129

A light green gray rock.

23130

23131

23132

<dt> Variants:</dt>

23133

23134

<dt> <img src="images/st_greengray.png" alt="images/st_greengray"> st_greengray

23135

</dt>

23136

</dl>

23137

</dd>

23138

</dl>

23139

23140

23141

23142

23143

23144

23145

23146

23147

23148

23149

23150

23151

23152

23153

23154

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

23155

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

23156

23157

</tr></table>

23158

23159

<h3 class="subsection">9.3.10 st_invisible</h3>

23160

23161

23162

An invisible stone that exists in all three variants. Please make rare usage

23163

of this stone as it may be very annoying to users to guess that a stone

23164

exists that he can not see. Use it to maintain the WYSIWYG expected behaviour.

23165

23166

Invisibility is not equal to laser transparency. In fact this stone is not

23167

laser transparent. And invisibility does not mean that an invisible actor can

23168

pass (see section <a href="#Transparent-Stones">Transparent Stones</a>).

23169

23170

23171

<dt> Variants:</dt>

23172

23173

<dt> st_invisible</dt>

23174

<dt> st_invisible_hollow</dt>

23175

<dt> st_invisible_movable</dt>

23176

</dl>

23177

</dd>

23178

</dl>

23179

23180

23181

23182

23183

23184

23185

23186

23187

23188

23189

23190

23191

23192

23193

23194

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

23195

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

23196

23197

</tr></table>

23198

23199

<h3 class="subsection">9.3.11 st_metal</h3>

23200

23201

23202

A metal stone that exists in two variants.

23203

23204

23205

<dt> Variants:</dt>

23206

23207

<dt> <img src="images/st_metal.png" alt="images/st_metal"> st_metal

23208

</dt>

23209

<dt> st_metal_hollow</dt>

23210

</dl>

23211

</dd>

23212

</dl>

23213

23214

23215

23216

23217

23218

23219

23220

23221

23222

23223

23224

23225

23226

23227

23228

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

23229

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

23230

23231

</tr></table>

23232

23233

<h3 class="subsection">9.3.12 st_pinkbumps</h3>

23234

23235

23236

A pink stone with heavy white bumps.

23237

23238

23239

<dt> Variants:</dt>

23240

23241

<dt> <img src="images/st_pinkbumps.png" alt="images/st_pinkbumps"> st_pinkbumps

23242

</dt>

23243

</dl>

23244

</dd>

23245

</dl>

23246

23247

23248

23249

23250

23251

23252

23253

23254

23255

23256

23257

23258

23259

23260

23261

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

23262

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

23263

23264

</tr></table>

23265

23266

<h3 class="subsection">9.3.13 st_purplegray</h3>

23267

23268

23269

A dark purple gray rock.

23270

23271

23272

<dt> Variants:</dt>

23273

23274

<dt> <img src="images/st_purplegray.png" alt="images/st_purplegray"> st_purplegray

23275

</dt>

23276

</dl>

23277

</dd>

23278

</dl>

23279

23280

23281

23282

23283

23284

23285

23286

23287

23288

23289

23290

23291

23292

23293

23294

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

23295

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

23296

23297

</tr></table>

23298

23299

<h3 class="subsection">9.3.14 st_purplemarble</h3>

23300

23301

23302

A purple marble stone.

23303

23304

23305

<dt> Variants:</dt>

23306

23307

<dt> <img src="images/st_purplemarble.png" alt="images/st_purplemarble"> st_purplemarble

23308

</dt>

23309

</dl>

23310

</dd>

23311

</dl>

23312

23313

23314

23315

23316

23317

23318

23319

23320

23321

23322

23323

23324

23325

23326

23327

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

23328

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

23329

23330

</tr></table>

23331

23332

<h3 class="subsection">9.3.15 st_redbrown</h3>

23333

23334

23335

A brown stone with light red touches that exists in all three variants.

23336

23337

23338

<dt> Variants:</dt>

23339

23340

<dt> <img src="images/st_redbrown.png" alt="images/st_redbrown"> st_redbrown

23341

</dt>

23342

<dt> st_redbrown_hollow</dt>

23343

<dt> st_redbrown_movable</dt>

23344

</dl>

23345

</dd>

23346

</dl>

23347

23348

23349

23350

23351

23352

23353

23354

23355

23356

23357

23358

23359

23360

23361

23362

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

23363

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

23364

23365

</tr></table>

23366

23367

<h3 class="subsection">9.3.16 st_redmarble</h3>

23368

23369

23370

A red white marbled stone.

23371

23372

23373

<dt> Variants:</dt>

23374

23375

<dt> <img src="images/st_redmarble.png" alt="images/st_redmarble"> st_redmarble

23376

</dt>

23377

</dl>

23378

</dd>

23379

</dl>

23380

23381

23382

23383

23384

23385

23386

23387

23388

23389

23390

23391

23392

23393

23394

23395

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

23396

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

23397

23398

</tr></table>

23399

23400

<h3 class="subsection">9.3.17 st_redrock</h3>

23401

23402

23403

A dark red rock.

23404

23405

23406

<dt> Variants:</dt>

23407

23408

<dt> <img src="images/st_redrock.png" alt="images/st_redrock"> st_redrock

23409

</dt>

23410

</dl>

23411

</dd>

23412

</dl>

23413

23414

23415

23416

23417

23418

23419

23420

23421

23422

23423

23424

23425

23426

23427

23428

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

23429

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

23430

23431

</tr></table>

23432

23433

<h3 class="subsection">9.3.18 st_tigris</h3>

23434

23435

23436

A red sandstone like <a href="#fl_005ftigris">fl_tigris</a>.

23437

23438

23439

<dt> Variants:</dt>

23440

23441

<dt> <img src="images/st_tigris.png" alt="images/st_tigris"> st_tigris

23442

</dt>

23443

</dl>

23444

</dd>

23445

</dl>

23446

23447

23448

23449

23450

23451

23452

23453

23454

23455

23456

23457

23458

23459

23460

23461

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

23462

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

23463

23464

</tr></table>

23465

23466

<h3 class="subsection">9.3.19 st_woven</h3>

23467

23468

23469

A yellow gray woven stone.

23470

23471

23472

<dt> Variants:</dt>

23473

23474

<dt> <img src="images/st_woven.png" alt="images/st_woven"> st_woven

23475

</dt>

23476

</dl>

23477

</dd>

23478

</dl>

23479

23480

23481

23482

23483

23484

23485

23486

23487

23488

23489

23490

23491

23492

23493

23494

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

23495

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

23496

23497

</tr></table>

23498

23499

<h3 class="subsection">9.3.20 st_yellow</h3>

23500

23501

23502

A yellow stone with red green stripes. This stone fits visually to the

23503

<a href="#st_005fcoinslot">st_coinslot</a>.

23504

23505

23506

<dt> Variants:</dt>

23507

23508

<dt> <img src="images/st_yellow.png" alt="images/st_yellow"> st_yellow

23509

</dt>

23510

</dl>

23511

</dd>

23512

</dl>

23513

23514

23515

23516

23517

23518

23519

23520

23521

23522

23523

23524

23525

23526

23527

23528

23529

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

23530

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

23531

23532

</tr></table>

23533

23534

<h2 class="section">9.4 Cluster Stones</h2>

23535

23536

A cluster stone is a passive wall stone like a simple stone. But several

23537

cluster stones adjacent to each other can visually build a cluster and look

23538

like a single big stone with a one common outer face.

23539

23540

23541

<tr><td align="left" valign="top"><a href="#Cluster-Features">9.4.1 Cluster Features</a></td><td>  </td><td align="left" valign="top"> Common Attributes and Features

23542

</td></tr>

23543

<tr><td align="left" valign="top"><a href="#st_005fbluesand">9.4.2 st_bluesand</a></td><td>  </td><td align="left" valign="top"> big sand stone look

23544

</td></tr>

23545

<tr><td align="left" valign="top"><a href="#st_005fbrick">9.4.3 st_brick</a></td><td>  </td><td align="left" valign="top"> brick wall look

23546

</td></tr>

23547

<tr><td align="left" valign="top"><a href="#st_005fpanel">9.4.4 st_panel</a></td><td>  </td><td align="left" valign="top"> wooden panel look

23548

</td></tr>

23549

</table>

23550

23551

23552

23553

23554

23555

23556

23557

23558

23559

23560

23561

23562

23563

23564

23565

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

23566

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

23567

23568

</tr></table>

23569

23570

<h3 class="subsection">9.4.1 Cluster Features</h3>

23571

23572

For each cluster stone there exist 16 different variations that represent all

23573

needed combinations of inner and outer faces to build arbitrary shaped big

23574

blocks.

23575

23576

There exist two methods of describing a special variation. You can either give

23577

the inner faces, the ‘<samp>connections</samp>’, those sides that should be adjacent to

23578

other stones of the same cluster. Or you can give the outer faces, the

23579

‘<samp>faces</samp>’, that build the common outer face of the resulting big block.

23580

23581

As it is a tedious work to set up larger blocks by their single stones with

23582

appropriate faces you can rely on an automatic clustering feature. Just

23583

set the ‘<samp>cluster</samp>’ attribute of all single stones of a big block to the

23584

same number and the faces will be set up automatically to form a large block.

23585

23586

You can build a screen of arbitrary big blocks and it is proven that there will

23587

never be the need of more than 4 different cluster numbers (the "4 color

23588

theorem"). But for convenience you are free to use additional cluster numbers

23589

as you like. Note that the autoclustering is quite dynamic. A single cluster

23590

stone with fitting cluster number that is swapped at the side of an existing

23591

block with the same cluster number will melt and join the block like seen in

23592

"Terminator 2".

23593

23594

We recommend making use of the autoclustering feature by setting the

23595

‘<samp>cluster</samp>’ attribute and using the ‘<samp>faces</samp>’ attribute where necessary.

23596

‘<samp>connections</samp>’ attribute and explicit naming of variations by a suffix

23597

are deprecated, but will continue to be supported.

23598

23599

23600

<dt> Attributes:</dt>

23601

<dd>

23602

23603

<dt> connections,   values: string;   default: <code>nil</code></dt>

23604

<dd>Describes the inner faces of stone. The string is a substring of <code>"nesw"</code>

23605

listing the inner faces. The sequence of the sides, north, east, south, west,

23606

is guaranteed on read access but arbitrary on write access.

23607

23608

</dd>

23609

<dt> faces   values: string;   default: <code>nil</code></dt>

23610

<dd>Describes the outer faces of stone. The string is a substring of <code>"nesw"</code>

23611

listing the outer faces. The sequence of the sides, north, east, south, west,

23612

is guaranteed on read access but arbitrary on write access.

23613

23614

</dd>

23615

<dt> cluster   values: number;   default: <code>nil</code></dt>

23616

<dd>If set to a number all adjacent cluster stones of the same base type with

23617

the identical cluster number will build a big block. This attribute supersedes

23618

any explicitly given face description.

23619

23620

</dd>

23621

</dl>

23622

</dd>

23623

</dl>

23624

23625

23626

23627

23628

23629

23630

23631

23632

23633

23634

23635

23636

23637

23638

23639

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

23640

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

23641

23642

</tr></table>

23643

23644

<h3 class="subsection">9.4.2 st_bluesand</h3>

23645

23646

23647

A standard cluster stone with the <a href="#Cluster-Features">Cluster Features</a>. It is recommended

23648

to use ‘<samp>st_bluesand</samp>’ with the attributes ‘<samp>cluster</samp>’ and ‘<samp>faces</samp>’.

23649

23650

23651

<dt> Variants:</dt>

23652

23653

<tr><td width="8%"><img src="images/st_bluesand.png" alt="images/st_bluesand"></td><td width="42%">st_bluesand: connections = <code>""</code></td><td width="8%"><img src="images/st_bluesand_2.png" alt="images/st_bluesand_2"></td><td width="42%">st_bluesand_w: connections = <code>"w"</code></td></tr>

23654

<tr><td width="8%"><img src="images/st_bluesand_3.png" alt="images/st_bluesand_3"></td><td width="42%">st_bluesand_s: connections = <code>"s"</code></td><td width="8%"><img src="images/st_bluesand_4.png" alt="images/st_bluesand_4"></td><td width="42%">st_bluesand_sw: connections = <code>"sw"</code></td></tr>

23655

<tr><td width="8%"><img src="images/st_bluesand_b.png" alt="images/st_bluesand_b"></td><td width="42%">st_bluesand_e: connections = <code>"e"</code></td><td width="8%"><img src="images/st_bluesand_b2.png" alt="images/st_bluesand_b2"></td><td width="42%">st_bluesand_ew: connections = <code>"ew"</code></td></tr>

23656

<tr><td width="8%"><img src="images/st_bluesand_b3.png" alt="images/st_bluesand_b3"></td><td width="42%">st_bluesand_es: connections = <code>"es"</code></td><td width="8%"><img src="images/st_bluesand_b4.png" alt="images/st_bluesand_b4"></td><td width="42%">st_bluesand_esw: connections = <code>"esw"</code></td></tr>

23657

<tr><td width="8%"><img src="images/st_bluesand_c.png" alt="images/st_bluesand_c"></td><td width="42%">st_bluesand_n: connections = <code>"n"</code></td><td width="8%"><img src="images/st_bluesand_c2.png" alt="images/st_bluesand_c2"></td><td width="42%">st_bluesand_nw: connections = <code>"nw"</code></td></tr>

23658

<tr><td width="8%"><img src="images/st_bluesand_c3.png" alt="images/st_bluesand_c3"></td><td width="42%">st_bluesand_ns: connections = <code>"ns"</code></td><td width="8%"><img src="images/st_bluesand_c4.png" alt="images/st_bluesand_c4"></td><td width="42%">st_bluesand_nsw: connections = <code>"nsw"</code></td></tr>

23659

<tr><td width="8%"><img src="images/st_bluesand_d.png" alt="images/st_bluesand_d"></td><td width="42%">st_bluesand_ne: connections = <code>"ne"</code></td><td width="8%"><img src="images/st_bluesand_d2.png" alt="images/st_bluesand_d2"></td><td width="42%">st_bluesand_new: connections = <code>"new"</code></td></tr>

23660

<tr><td width="8%"><img src="images/st_bluesand_d3.png" alt="images/st_bluesand_d3"></td><td width="42%">st_bluesand_nes: connections = <code>"nes"</code></td><td width="8%"><img src="images/st_bluesand_d4.png" alt="images/st_bluesand_d4"></td><td width="42%">st_bluesand_nesw: connections = <code>"nesw"</code></td></tr>

23661

</table>

23662

</dd>

23663

</dl>

23664

23665

23666

23667

23668

23669

23670

23671

23672

23673

23674

23675

23676

23677

23678

23679

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

23680

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

23681

23682

</tr></table>

23683

23684

<h3 class="subsection">9.4.3 st_brick</h3>

23685

23686

23687

A standard cluster stone with the <a href="#Cluster-Features">Cluster Features</a>. It is recommended

23688

to use ‘<samp>st_brick</samp>’ with the attributes ‘<samp>cluster</samp>’ and ‘<samp>faces</samp>’.

23689

23690

23691

<dt> Variants:</dt>

23692

23693

<tr><td width="8%"><img src="images/st_brick.png" alt="images/st_brick"></td><td width="42%">st_brick: connections = <code>""</code></td><td width="8%"><img src="images/st_brick_2.png" alt="images/st_brick_2"></td><td width="42%">st_brick_w: connections = <code>"w"</code></td></tr>

23694

<tr><td width="8%"><img src="images/st_brick_3.png" alt="images/st_brick_3"></td><td width="42%">st_brick_s: connections = <code>"s"</code></td><td width="8%"><img src="images/st_brick_4.png" alt="images/st_brick_4"></td><td width="42%">st_brick_sw: connections = <code>"sw"</code></td></tr>

23695

<tr><td width="8%"><img src="images/st_brick_b.png" alt="images/st_brick_b"></td><td width="42%">st_brick_e: connections = <code>"e"</code></td><td width="8%"><img src="images/st_brick_b2.png" alt="images/st_brick_b2"></td><td width="42%">st_brick_ew: connections = <code>"ew"</code></td></tr>

23696

<tr><td width="8%"><img src="images/st_brick_b3.png" alt="images/st_brick_b3"></td><td width="42%">st_brick_es: connections = <code>"es"</code></td><td width="8%"><img src="images/st_brick_b4.png" alt="images/st_brick_b4"></td><td width="42%">st_brick_esw: connections = <code>"esw"</code></td></tr>

23697

<tr><td width="8%"><img src="images/st_brick_c.png" alt="images/st_brick_c"></td><td width="42%">st_brick_n: connections = <code>"n"</code></td><td width="8%"><img src="images/st_brick_c2.png" alt="images/st_brick_c2"></td><td width="42%">st_brick_nw: connections = <code>"nw"</code></td></tr>

23698

<tr><td width="8%"><img src="images/st_brick_c3.png" alt="images/st_brick_c3"></td><td width="42%">st_brick_ns: connections = <code>"ns"</code></td><td width="8%"><img src="images/st_brick_c4.png" alt="images/st_brick_c4"></td><td width="42%">st_brick_nsw: connections = <code>"nsw"</code></td></tr>

23699

<tr><td width="8%"><img src="images/st_brick_d.png" alt="images/st_brick_d"></td><td width="42%">st_brick_ne: connections = <code>"ne"</code></td><td width="8%"><img src="images/st_brick_d2.png" alt="images/st_brick_d2"></td><td width="42%">st_brick_new: connections = <code>"new"</code></td></tr>

23700

<tr><td width="8%"><img src="images/st_brick_d3.png" alt="images/st_brick_d3"></td><td width="42%">st_brick_nes: connections = <code>"nes"</code></td><td width="8%"><img src="images/st_brick_d4.png" alt="images/st_brick_d4"></td><td width="42%">st_brick_nesw: connections = <code>"nesw"</code></td></tr>

23701

</table>

23702

</dd>

23703

</dl>

23704

23705

23706

23707

23708

23709

23710

23711

23712

23713

23714

23715

23716

23717

23718

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

23719

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

23720

23721

</tr></table>

23722

23723

<h3 class="subsection">9.4.4 st_panel</h3>

23724

23725

23726

A standard cluster stone with the <a href="#Cluster-Features">Cluster Features</a>. It is recommended

23727

to use ‘<samp>st_panel</samp>’ with the attributes ‘<samp>cluster</samp>’ and ‘<samp>faces</samp>’.

23728

23729

23730

<dt> Variants:</dt>

23731

23732

<tr><td width="8%"><img src="images/st_panel.png" alt="images/st_panel"></td><td width="42%">st_panel: connections = <code>""</code></td><td width="8%"><img src="images/st_panel_2.png" alt="images/st_panel_2"></td><td width="42%">st_panel_w: connections = <code>"w"</code></td></tr>

23733

<tr><td width="8%"><img src="images/st_panel_3.png" alt="images/st_panel_3"></td><td width="42%">st_panel_s: connections = <code>"s"</code></td><td width="8%"><img src="images/st_panel_4.png" alt="images/st_panel_4"></td><td width="42%">st_panel_sw: connections = <code>"sw"</code></td></tr>

23734

<tr><td width="8%"><img src="images/st_panel_b.png" alt="images/st_panel_b"></td><td width="42%">st_panel_e: connections = <code>"e"</code></td><td width="8%"><img src="images/st_panel_b2.png" alt="images/st_panel_b2"></td><td width="42%">st_panel_ew: connections = <code>"ew"</code></td></tr>

23735

<tr><td width="8%"><img src="images/st_panel_b3.png" alt="images/st_panel_b3"></td><td width="42%">st_panel_es: connections = <code>"es"</code></td><td width="8%"><img src="images/st_panel_b4.png" alt="images/st_panel_b4"></td><td width="42%">st_panel_esw: connections = <code>"esw"</code></td></tr>

23736

<tr><td width="8%"><img src="images/st_panel_c.png" alt="images/st_panel_c"></td><td width="42%">st_panel_n: connections = <code>"n"</code></td><td width="8%"><img src="images/st_panel_c2.png" alt="images/st_panel_c2"></td><td width="42%">st_panel_nw: connections = <code>"nw"</code></td></tr>

23737

<tr><td width="8%"><img src="images/st_panel_c3.png" alt="images/st_panel_c3"></td><td width="42%">st_panel_ns: connections = <code>"ns"</code></td><td width="8%"><img src="images/st_panel_c4.png" alt="images/st_panel_c4"></td><td width="42%">st_panel_nsw: connections = <code>"nsw"</code></td></tr>

23738

<tr><td width="8%"><img src="images/st_panel_d.png" alt="images/st_panel_d"></td><td width="42%">st_panel_ne: connections = <code>"ne"</code></td><td width="8%"><img src="images/st_panel_d2.png" alt="images/st_panel_d2"></td><td width="42%">st_panel_new: connections = <code>"new"</code></td></tr>

23739

<tr><td width="8%"><img src="images/st_panel_d3.png" alt="images/st_panel_d3"></td><td width="42%">st_panel_nes: connections = <code>"nes"</code></td><td width="8%"><img src="images/st_panel_d4.png" alt="images/st_panel_d4"></td><td width="42%">st_panel_nesw: connections = <code>"nesw"</code></td></tr>

23740

</table>

23741

</dd>

23742

</dl>

23743

23744

23745

23746

23747

23748

23749

23750

23751

23752

23753

23754

23755

23756

23757

23758

23759

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

23760

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

23761

23762

</tr></table>

23763

23764

<h2 class="section">9.5 Special Stones</h2>

23765

23766

23767

<tr><td align="left" valign="top"><a href="#st_005factorimpulse">9.5.1 st_actorimpulse</a></td><td>  </td><td align="left" valign="top"> Bumper Stone

23768

</td></tr>

23769

<tr><td align="left" valign="top"><a href="#st_005fbarrier">9.5.2 st_barrier</a></td><td>  </td><td align="left" valign="top"> Barrier for item carrying actors

23770

</td></tr>

23771

<tr><td align="left" valign="top"><a href="#st_005fbeads">9.5.3 st_beads</a></td><td>  </td><td align="left" valign="top"> Frame of Glass Beads

23772

</td></tr>

23773

<tr><td align="left" valign="top"><a href="#st_005fblocker">9.5.4 st_blocker</a></td><td>  </td><td align="left" valign="top"> Shrinkable Blocker

23774

</td></tr>

23775

<tr><td align="left" valign="top"><a href="#st_005fblur">9.5.5 st_blur</a></td><td>  </td><td align="left" valign="top"> Passage of yet undetermined color

23776

</td></tr>

23777

<tr><td align="left" valign="top"><a href="#st_005fboulder">9.5.6 st_boulder</a></td><td>  </td><td align="left" valign="top"> Moving Arrow Boulder

23778

</td></tr>

23779

<tr><td align="left" valign="top"><a href="#st_005fbox">9.5.7 st_box</a></td><td>  </td><td align="left" valign="top"> Movable, Floor building Box

23780

</td></tr>

23781

<tr><td align="left" valign="top"><a href="#st_005fbrake">9.5.8 st_brake</a></td><td>  </td><td align="left" valign="top"> Brake for moving Boulders

23782

</td></tr>

23783

<tr><td align="left" valign="top"><a href="#st_005fbreak">9.5.9 st_break</a></td><td>  </td><td align="left" valign="top"> Breakable Stone of various Flavors

23784

</td></tr>

23785

<tr><td align="left" valign="top"><a href="#st_005fbrownpyramid">9.5.10 st_brownpyramid</a></td><td>  </td><td align="left" valign="top"> Brown gray pyramid shaped stone

23786

</td></tr>

23787

<tr><td align="left" valign="top"><a href="#st_005fchameleon">9.5.11 st_chameleon</a></td><td>  </td><td align="left" valign="top"> Floor Mimic

23788

</td></tr>

23789

<tr><td align="left" valign="top"><a href="#st_005fcharge">9.5.12 st_charge</a></td><td>  </td><td align="left" valign="top"> Electrical Charger

23790

</td></tr>

23791

<tr><td align="left" valign="top"><a href="#st_005fchess">9.5.13 st_chess</a></td><td>  </td><td align="left" valign="top"> Movable Chess Knight Stone

23792

</td></tr>

23793

<tr><td align="left" valign="top"><a href="#st_005fcoinslot">9.5.14 st_coinslot</a></td><td>  </td><td align="left" valign="top"> Coin Driven Switch

23794

</td></tr>

23795

<tr><td align="left" valign="top"><a href="#st_005fdarkglass">9.5.15 st_darkglass</a></td><td>  </td><td align="left" valign="top"> Semitransparent metal framed Glass

23796

</td></tr>

23797

<tr><td align="left" valign="top"><a href="#st_005fdeath">9.5.16 st_death</a></td><td>  </td><td align="left" valign="top"> Skull Stone

23798

</td></tr>

23799

<tr><td align="left" valign="top"><a href="#st_005fdisco">9.5.17 st_disco</a></td><td>  </td><td align="left" valign="top"> Light shading Stone

23800

</td></tr>

23801

<tr><td align="left" valign="top"><a href="#st_005fdispenser">9.5.18 st_dispenser</a></td><td>  </td><td align="left" valign="top"> Item Dispenser

23802

</td></tr>

23803

<tr><td align="left" valign="top"><a href="#st_005fdoor">9.5.19 st_door</a></td><td>  </td><td align="left" valign="top"> Door of various Flavors

23804

</td></tr>

23805

<tr><td align="left" valign="top"><a href="#st_005ffake">9.5.20 st_fake</a></td><td>  </td><td align="left" valign="top"> Fake mimicking other Stones

23806

</td></tr>

23807

<tr><td align="left" valign="top"><a href="#st_005fflash">9.5.21 st_flash</a></td><td>  </td><td align="left" valign="top"> Partner Marble pushing Stone

23808

</td></tr>

23809

<tr><td align="left" valign="top"><a href="#st_005fflat">9.5.22 st_flat</a></td><td>  </td><td align="left" valign="top"> Featured Gypsum Stone

23810

</td></tr>

23811

<tr><td align="left" valign="top"><a href="#st_005ffloppy">9.5.23 st_floppy</a></td><td>  </td><td align="left" valign="top"> Floppy Driven Switch

23812

</td></tr>

23813

<tr><td align="left" valign="top"><a href="#st_005ffourswitch">9.5.24 st_fourswitch</a></td><td>  </td><td align="left" valign="top"> Four Orientation Switch

23814

</td></tr>

23815

<tr><td align="left" valign="top"><a href="#st_005fghost">9.5.25 st_ghost</a></td><td>  </td><td align="left" valign="top"> Invisible Transforming Stone

23816

</td></tr>

23817

<tr><td align="left" valign="top"><a href="#st_005fgrate">9.5.26 st_grate</a></td><td>  </td><td align="left" valign="top"> Hovering metal Grate

23818

</td></tr>

23819

<tr><td align="left" valign="top"><a href="#st_005fgreenbrown">9.5.27 st_greenbrown</a></td><td>  </td><td align="left" valign="top"> Mainly brown seedable stone

23820

</td></tr>

23821

<tr><td align="left" valign="top"><a href="#st_005fice">9.5.28 st_ice</a></td><td>  </td><td align="left" valign="top"> Item and Floor freezing Ice block

23822

</td></tr>

23823

<tr><td align="left" valign="top"><a href="#st_005fjamb">9.5.29 st_jamb</a></td><td>  </td><td align="left" valign="top"> Colored Door Jamb

23824

</td></tr>

23825

<tr><td align="left" valign="top"><a href="#st_005fkey">9.5.30 st_key</a></td><td>  </td><td align="left" valign="top"> Key Driven Switch

23826

</td></tr>

23827

<tr><td align="left" valign="top"><a href="#st_005fknight">9.5.31 st_knight</a></td><td>  </td><td align="left" valign="top"> Sword Bearing Knight Stone

23828

</td></tr>

23829

<tr><td align="left" valign="top"><a href="#st_005flaser">9.5.32 st_laser</a></td><td>  </td><td align="left" valign="top"> Light emitting Laser

23830

</td></tr>

23831

<tr><td align="left" valign="top"><a href="#st_005flaserflop">9.5.33 st_laserflop</a></td><td>  </td><td align="left" valign="top"> Light sensitive Monoflop

23832

</td></tr>

23833

<tr><td align="left" valign="top"><a href="#st_005flaserswitch">9.5.34 st_laserswitch</a></td><td>  </td><td align="left" valign="top"> Light sensitive Switch

23834

</td></tr>

23835

<tr><td align="left" valign="top"><a href="#st_005flightglass">9.5.35 st_lightglass</a></td><td>  </td><td align="left" valign="top"> Transparent metal framed Glass

23836

</td></tr>

23837

<tr><td align="left" valign="top"><a href="#st_005flightpassenger">9.5.36 st_lightpassenger</a></td><td>  </td><td align="left" valign="top"> Stone pushed by Light

23838

</td></tr>

23839

<tr><td align="left" valign="top"><a href="#st_005fmagic">9.5.37 st_magic</a></td><td>  </td><td align="left" valign="top"> Magic Transforming Stone

23840

</td></tr>

23841

<tr><td align="left" valign="top"><a href="#st_005fmail">9.5.38 st_mail</a></td><td>  </td><td align="left" valign="top"> Mail office for Item transportation

23842

</td></tr>

23843

<tr><td align="left" valign="top"><a href="#st_005fmirror">9.5.39 st_mirror</a></td><td>  </td><td align="left" valign="top"> Mirrors of all flavors

23844

</td></tr>

23845

<tr><td align="left" valign="top"><a href="#st_005fmonoflop">9.5.40 st_monoflop</a></td><td>  </td><td align="left" valign="top"> Monoflop Switch

23846

</td></tr>

23847

<tr><td align="left" valign="top"><a href="#st_005foneway">9.5.41 st_oneway</a></td><td>  </td><td align="left" valign="top"> Oneway Passage

23848

</td></tr>

23849

<tr><td align="left" valign="top"><a href="#st_005foxyd">9.5.42 st_oxyd</a></td><td>  </td><td align="left" valign="top"> Game Target Stone

23850

</td></tr>

23851

<tr><td align="left" valign="top"><a href="#st_005fpassage">9.5.43 st_passage</a></td><td>  </td><td align="left" valign="top"> Color dependent Passage

23852

</td></tr>

23853

<tr><td align="left" valign="top"><a href="#st_005fplaster">9.5.44 st_plaster</a></td><td>  </td><td align="left" valign="top"> Gypsum sculptured Stone

23854

</td></tr>

23855

<tr><td align="left" valign="top"><a href="#st_005fplop">9.5.45 st_plop</a></td><td>  </td><td align="left" valign="top"> Movable stone ceasing by a Plop

23856

</td></tr>

23857

<tr><td align="left" valign="top"><a href="#st_005fpolarswitch">9.5.46 st_polarswitch</a></td><td>  </td><td align="left" valign="top"> Transparency Switch for Light Beams

23858

</td></tr>

23859

<tr><td align="left" valign="top"><a href="#st_005fportal">9.5.47 st_portal</a></td><td>  </td><td align="left" valign="top"> Gate just passable by some Actor kinds

23860

</td></tr>

23861

<tr><td align="left" valign="top"><a href="#st_005fpull">9.5.48 st_pull</a></td><td>  </td><td align="left" valign="top"> Pullable Stone

23862

</td></tr>

23863

<tr><td align="left" valign="top"><a href="#st_005fpuzzle">9.5.49 st_puzzle</a></td><td>  </td><td align="left" valign="top"> Clusterable Puzzle Stones

23864

</td></tr>

23865

<tr><td align="left" valign="top"><a href="#st_005fquake">9.5.50 st_quake</a></td><td>  </td><td align="left" valign="top"> Oxyd closing Stone

23866

</td></tr>

23867

<tr><td align="left" valign="top"><a href="#st_005frawglass">9.5.51 st_rawglass</a></td><td>  </td><td align="left" valign="top"> Transparent Glass Block

23868

</td></tr>

23869

<tr><td align="left" valign="top"><a href="#st_005fredfiber">9.5.52 st_redfiber</a></td><td>  </td><td align="left" valign="top"> Woven Fiber in a metal Frame

23870

</td></tr>

23871

<tr><td align="left" valign="top"><a href="#st_005frotator">9.5.53 st_rotator</a></td><td>  </td><td align="left" valign="top"> Rotating Stone Impulser

23872

</td></tr>

23873

<tr><td align="left" valign="top"><a href="#st_005frubberband">9.5.54 st_rubberband</a></td><td>  </td><td align="left" valign="top"> Rubberband generator

23874

</td></tr>

23875

<tr><td align="left" valign="top"><a href="#st_005fscissors">9.5.55 st_scissors</a></td><td>  </td><td align="left" valign="top"> Scissors cutting rubberbands

23876

</td></tr>

23877

<tr><td align="left" valign="top"><a href="#st_005fshogun">9.5.56 st_shogun</a></td><td>  </td><td align="left" valign="top"> Stackable Hole Stones

23878

</td></tr>

23879

<tr><td align="left" valign="top"><a href="#st_005fspitter">9.5.57 st_spitter</a></td><td>  </td><td align="left" valign="top"> Cannonball spitting Stone

23880

</td></tr>

23881

<tr><td align="left" valign="top"><a href="#st_005fstoneimpulse">9.5.58 st_stoneimpulse</a></td><td>  </td><td align="left" valign="top"> Neighbor Pushing pulsing Stone

23882

</td></tr>

23883

<tr><td align="left" valign="top"><a href="#st_005fsurprise">9.5.59 st_surprise</a></td><td>  </td><td align="left" valign="top"> Random Transforming Stone

23884

</td></tr>

23885

<tr><td align="left" valign="top"><a href="#st_005fswap">9.5.60 st_swap</a></td><td>  </td><td align="left" valign="top"> Neighbor Swapping Stone

23886

</td></tr>

23887

<tr><td align="left" valign="top"><a href="#st_005fswitch">9.5.61 st_switch</a></td><td>  </td><td align="left" valign="top"> Classical on/off Switch

23888

</td></tr>

23889

<tr><td align="left" valign="top"><a href="#st_005fthief">9.5.62 st_thief</a></td><td>  </td><td align="left" valign="top"> Item Thief

23890

</td></tr>

23891

<tr><td align="left" valign="top"><a href="#st_005ftimer">9.5.63 st_timer</a></td><td>  </td><td align="left" valign="top"> Animated Timer

23892

</td></tr>

23893

<tr><td align="left" valign="top"><a href="#st_005fturnstile">9.5.64 st_turnstile</a></td><td>  </td><td align="left" valign="top"> Turnstile Pivot

23894

</td></tr>

23895

<tr><td align="left" valign="top"><a href="#st_005fturnstilearm">9.5.65 st_turnstilearm</a></td><td>  </td><td align="left" valign="top"> Turnstile Arm

23896

</td></tr>

23897

<tr><td align="left" valign="top"><a href="#st_005fvolcano">9.5.66 st_volcano</a></td><td>  </td><td align="left" valign="top"> Spreading Volcano

23898

</td></tr>

23899

<tr><td align="left" valign="top"><a href="#st_005fwindow">9.5.67 st_window</a></td><td>  </td><td align="left" valign="top"> Faced Window

23900

</td></tr>

23901

<tr><td align="left" valign="top"><a href="#st_005fyinyang">9.5.68 st_yinyang</a></td><td>  </td><td align="left" valign="top"> Player Switch

23902

</td></tr>

23903

</table>

23904

23905

23906

23907

23908

23909

23910

23911

23912

23913

23914

23915

23916

23917

23918

23919

23920

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

23921

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

23922

23923

</tr></table>

23924

23925

<h3 class="subsection">9.5.1 st_actorimpulse</h3>

23926

23927

23928

An active bumper for actors and some stones like <a href="#st_005fboulder">st_boulder</a>. The

23929

actorimpulse stone can be made invisible while idle to introduce some surprise

23930

effects.

23931

23932

Actors that hit this stone will not be reflected just passively. An additional

23933

force will be applied to them that can even be distorted. By default the actors

23934

are just pushed away from the center of the stone. A global attribute

23935

<a href="#ActorimpulseStrength">ActorimpulseStrength</a> gives a default force that can be overridden by the

23936

stone attribute ‘<samp>strength</samp>’.

23937

23938

For sophisticated usage you can distort this force by usage of the <a href="#hit_005f_002a">hit_*</a>

23939

attributes. Note that the ‘<samp>hit_factor</samp>’ overrides a ‘<samp>strength</samp>’

23940

attribute.

23941

23942

An actorimpulse stone can be configured by the ‘<samp>invisible</samp>’ attribute to

23943

be hidden while being idle. While pulsing any actorimpulse is visible. An

23944

invisible actorimpulse can be made permanently visible by hitting it with a

23945

revealed <a href="#it_005fbrush">it_brush</a> in the player’s inventory. The level author can configure

23946

<a href="#it_005fglasses">it_glasses</a> by addition of ‘<samp>SPOT_ACTORIMPULSE</samp>’ to show otherwise

23947

invisible actorimpulse stones. With the global attribute <a href="#ExtralifeGlasses">ExtralifeGlasses</a>

23948

even glasses generated by laser lighting an <a href="#it_005fextralife">it_extralife</a> can be configured

23949

to show invisible actorimpulse stones.

23950

23951

An <a href="#st_005fboulder">st_boulder</a> hitting an actorimpulse stone will revert its orientation

23952

and return in the incoming direction.

23953

23954

23955

<dt> Attributes:</dt>

23956

<dd>

23957

23958

<dt> invisible   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

23959

<dd>An invisible actorimpulse stone is totally transparent. But the user will

23960

notice it, as actors will bounce with additional impulses.

23961

</dd>

23962

<dt> strength   values: float number;   default: <code>+200.0</code>   See section <a href="#ActorimpulseStrength">ActorimpulseStrength</a></dt>

23963

<dd>A scalar factor for the impulse force. Positive numbers are attracting forces

23964

where as negative numbers are repelling forces.

23965

</dd>

23966

<dt> hit_strength   values: float number;   default: <code>nil</code>   See section <a href="#hit_005f_002a">hit_*</a></dt>

23967

<dd>A ‘<samp>hit_strength</samp>’ overrides a given ‘<samp>strength</samp>’ attribute.

23968

</dd>

23969

<dt> hit_distortion_xx   values: float number;   default: <code>+1.0</code>   See section <a href="#hit_005f_002a">hit_*</a></dt>

23970

<dt> hit_distortion_xy   values: float number;   default: <code>0.0</code>   See section <a href="#hit_005f_002a">hit_*</a></dt>

23971

<dt> hit_distortion_yx   values: float number;   default: <code>0.0</code>   See section <a href="#hit_005f_002a">hit_*</a></dt>

23972

<dt> hit_distortion_yy   values: float number;   default: <code>+1.0</code>   See section <a href="#hit_005f_002a">hit_*</a></dt>

23973

</dl>

23974

23975

</dd>

23976

<dt> Messages: none</dt>

23977

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

23978

<dt> Variants:</dt>

23979

<dd>

23980

23981

<dt> <img src="images/st_actorimpulse.png" alt="images/st_actorimpulse"> st_actorimpulse: invisible = <code>false</code>

23982

</dt>

23983

<dt> <img src="images/fl_white.png" alt="images/fl_white"> st_actorimpulse_invisible: invisible = <code>true</code>

23984

</dt>

23985

</dl>

23986

23987

</dd>

23988

</dl>

23989

23990

23991

23992

23993

23994

23995

23996

23997

23998

23999

24000

24001

24002

24003

24004

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

24005

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

24006

24007

</tr></table>

24008

24009

<h3 class="subsection">9.5.2 st_barrier</h3>

24010

24011

24012

The barrier stone blocks actors that carry a given item kind in their inventory.

24013

By blocking all entries to a given room by barriers of the same ‘<samp>flavor</samp>’

24014

you can assure that no actor can use the given item kind within the room, even

24015

when the item is available outside of the room. The barrier acts like customs

24016

service. The barrier performs a deep check investigating not only the top level

24017

of the actor’s inventory. Every <a href="#it_005fbag">it_bag</a> will be checked recursively, too,

24018

ensuring that no instance of the searched item can pass the barrier.

24019

24020

The ‘<samp>flavor</samp>’ attribute determines the blocked item kind. The string

24021

<code>"all"</code> blocks any item. Any string containing an <a href="#Object-Kind">Object Kind</a>

24022

will block items of just the given kind. Of course you can use just kinds of

24023

<a href="#portable">portable</a> items. E.g. a ‘<samp>flavor</samp>’ of <code>"it_flag_white"</code> will just

24024

block actors that carry a white <a href="#it_005fflag">it_flag</a>, while <code>"it_flag"</code> would

24025

block actors carrying flags of any color. The blocked item kind is indicated on

24026

top of the barrier stone.

24027

24028

Be aware that barrier stones can be circumvented with two actors exchanging

24029

their positions by <a href="#it_005fyinyang">it_yinyang</a> usage. As the player can not drop the

24030

<a href="#it_005fyinyang">it_yinyang</a> it is no use to add an additional barrier stone for this item.

24031

Multiple actors assigned to a single player are another potential shortcut of

24032

barrier stones.

24033

24034

As barrier stones are usually bound to their initial position to fulfill their

24035

item blocking task, they are kept from being swapped of pulled by the

24036

‘<samp>static</samp>’ attribute’s default of <code>true</code>.

24037

24038

24039

<dt> Attributes:</dt>

24040

<dd>

24041

24042

<dt> flavor   values: <code>"all"</code>, any portable item kind string;   default: <code>"all"</code></dt>

24043

<dd>The item kind to be searched for.

24044

</dd>

24045

<dt> static   values: <code>true</code>, <code>false</code>;   default: <code>true</code></dt>

24046

<dd>Static barriers are neither swappable nor pullable.

24047

</dd>

24048

</dl>

24049

24050

</dd>

24051

<dt> Messages: none</dt>

24052

<dt> Action: none</dt>

24053

<dt> Variants:</dt>

24054

24055

<dt> <img src="images/st_barrier.png" alt="images/st_barrier"> st_barrier: flavor=<code>"all"</code>

24056

</dt>

24057

</dl>

24058

</dd>

24059

</dl>

24060

24061

24062

24063

24064

24065

24066

24067

24068

24069

24070

24071

24072

24073

24074

24075

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

24076

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

24077

24078

</tr></table>

24079

24080

<h3 class="subsection">9.5.3 st_beads</h3>

24081

24082

24083

A stone framed by glass beads. Like other <a href="#Transparent-Stones">Transparent Stones</a> it is

24084

passable for invisible actors, but it is not transparent to laser beams.

24085

24086

Like <a href="#st_005foneway">st_oneway</a> the beads stone does not detain visible actors once they

24087

entered the grid and lets them leave on any side.

24088

24089

24090

<dt> Attributes: none</dt>

24091

<dt> Messages: none</dt>

24092

<dt> Variants:</dt>

24093

24094

<dt> <img src="images/st_beads.png" alt="images/st_beads"> st_beads

24095

</dt>

24096

</dl>

24097

24098

</dd>

24099

</dl>

24100

24101

24102

24103

24104

24105

24106

24107

24108

24109

24110

24111

24112

24113

24114

24115

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

24116

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

24117

24118

</tr></table>

24119

24120

<h3 class="subsection">9.5.4 st_blocker</h3>

24121

24122

24123

A door like object that shrinks to <a href="#it_005fblocker">it_blocker</a> when hit by an

24124

<a href="#st_005fboulder">st_boulder</a>. When the boulder did pass the blocker stays in its item like

24125

open state until it is passed again by a boulder which causes it to grow again

24126

to a blocker stone.

24127

24128

It fully supports the messages of any door like object and can be opened and

24129

closed by any switch like object. Note that due to the transformation between

24130

stone and item during opening and closing you should name the blocker

24131

(see section <a href="#name">name</a>) and address the blocker by this name. The complete identity

24132

with all attributes including any user attributes will be transferred between

24133

stone and item. E.g. ‘<samp>{st_switch, target="myblocker", action="toggle"}</samp>’

24134

will open and close a given blocker multiple times.

24135

24136

Note that the blocker is the only door object that allows a stone to be pushed

24137

through. Just boulders cause the growing. Any other stone keeps the open state.

24138

24139

Be aware that the <a href="#it_005fbrake">it_brake</a> destroys an <a href="#it_005fblocker">it_blocker</a>.

24140

24141

24142

<dt> Attributes:</dt>

24143

<dd>

24144

24145

<dt> state,   values: <code>OPEN</code>, <code>CLOSED</code>;   default: <code>CLOSED</code>   See section <a href="#state">state</a></dt>

24146

<dd>The stone represents the closed state and will always return state ‘<samp>CLOSED</samp>’.

24147

But you can set its state what is equivalent to sending an open message in case

24148

of value ‘<samp>OPEN</samp>’ and a close message in case of value ‘<samp>CLOSED</samp>’.

24149

24150

24151

</dd>

24152

<dt> autoclose   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

24153

<dd>This attribute is irrelevant to the blocker stone itself. But it is transferred

24154

to the <a href="#it_005fblocker">it_blocker</a> when the blocker opens.

24155

24156

</dd>

24157

</dl>

24158

24159

</dd>

24160

<dt> Messages:</dt>

24161

<dd>

24162

24163

<dt> signal   See section <a href="#signal">signal</a></dt>

24164

<dd>A signal of value 1 sends an open message, a signal of value 0 sends a close

24165

message.

24166

</dd>

24167

<dt> toggle   See section <a href="#toggle">toggle</a></dt>

24168

<dd>A toggle causes an open unless the blocker stone is in the shrinking process.

24169

In this case it causes a close message.

24170

</dd>

24171

<dt> open   See section <a href="#open">open</a></dt>

24172

<dd>Starts an opening by shrinking the blocker. Note that during the shrinking

24173

process the blocker still reports to be closed. The shrinking process can

24174

be reverted by a close message.

24175

</dd>

24176

<dt> close   See section <a href="#close">close</a></dt>

24177

<dd>A close message takes only effect on a blocker stone that is in the shrinking

24178

process. The shrinking is stopped immediately and reverted to grow the blocker

24179

again to full size.

24180

</dd>

24181

</dl>

24182

24183

</dd>

24184

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

24185

<dd>Sends an action at the moment the blocker reaches the closing state. That means

24186

an <a href="#it_005fblocker">it_blocker</a> did close and did generate this blocker stone as its

24187

successor. The value will be ‘<samp>false</samp>’ to express the closing state.

24188

24189

</dd>

24190

<dt> Variants:</dt>

24191

24192

<dt> <img src="images/st_blocker.png" alt="images/st_blocker"> st_blocker

24193

</dt>

24194

<dd>A standard blocker stone.

24195

</dd>

24196

<dt> <img src="images/st_blocker.png" alt="images/st_blocker"> st_blocker_new

24197

</dt>

24198

<dd>A blocker that just starts growing. Mainly used internally as the direct

24199

successor of an <a href="#it_005fblocker">it_blocker</a>. But it may be useful to generate an initial

24200

snapshot of a moving boulder over a blocker line, too. See example levels.

24201

</dd>

24202

</dl>

24203

24204

</dd>

24205

</dl>

24206

24207

24208

24209

24210

24211

24212

24213

24214

24215

24216

24217

24218

24219

24220

24221

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

24222

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

24223

24224

</tr></table>

24225

24226

24227

24228

24229

A gray stone that transforms on an actor hit into a <a href="#st_005fpassage">st_passage</a> depending

24230

on the color of actor. The color of the passage may be the same as

24231

the color of the actor or be of the opposite color. The flavor of the passage

24232

is always <code>"square"</code>.

24233

24234

In the first case the blur stone is pure gray and its ‘<samp>flavor</samp>’ is called

24235

<code>"straight"</code> due to the straight color preserving transformation. The

24236

touching actor will be able to pass the passage straight away.

24237

24238

In the second case the blur stone has an added white and black symbol to notify

24239

the player that, on touching the stone with a colored actor, this actor will not

24240

be able to pass the resulting passage. There are two flavors of such blur stones

24241

- <code>"cross"</code> which transform unconditionally on an actor hit to the opposite

24242

colored <a href="#st_005fpassage">st_passage</a> and flavor <code>"magic"</code> which transforms just on

24243

actors hitting the blur stone with a revealed <a href="#it_005fmagicwand">it_magicwand</a> or

24244

<a href="#it_005fbrush">it_brush</a> in their inventory.

24245

24246

For colorless actors a blur stone is just a standard stone without any special

24247

features.

24248

24249

24250

<dt> Attributes:</dt>

24251

<dd>

24252

24253

<dt> flavor   values: <code>"straight"</code>, <code>"cross"</code>, <code>"magic"</code>;   default: <code>"straight"</code></dt>

24254

<dd>The blur subkind.

24255

</dd>

24256

</dl>

24257

24258

</dd>

24259

<dt> Messages: none</dt>

24260

<dt> Action: none</dt>

24261

<dt> Variants:</dt>

24262

<dd>

24263

24264

<dt> <img src="images/st_blur_straight.png" alt="images/st_blur_straight"> st_blur: flavor = <code>"straight"</code>

24265

</dt>

24266

<dt> <img src="images/st_blur_straight.png" alt="images/st_blur_straight"> st_blur_straight: flavor = <code>"straight"</code>

24267

</dt>

24268

<dt> <img src="images/st_blur_cross.png" alt="images/st_blur_cross"> st_blur_cross: flavor = <code>"cross"</code>

24269

</dt>

24270

<dt> <img src="images/st_blur_cross.png" alt="images/st_blur_cross"> st_blur_magic: flavor = <code>"magic"</code>

24271

</dt>

24272

</dl>

24273

24274

</dd>

24275

</dl>

24276

24277

24278

24279

24280

24281

24282

24283

24284

24285

24286

24287

24288

24289

24290

24291

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

24292

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

24293

24294

</tr></table>

24295

24296

<h3 class="subsection">9.5.6 st_boulder</h3>

24297

24298

24299

This solid stone moves into the direction shown by the arrow on its picture.

24300

A marble blocking its way is shattered. When a stone blocks its way, the boulder

24301

triggers it by a sequence of two internal messages. Some stones give way like

24302

<a href="#st_005fblocker">st_blocker</a>, ‘<samp>st_break_boulder</samp>’ (see section <a href="#st_005fbreak">st_break</a>), others change their

24303

state like <a href="#st_005foxyd">st_oxyd</a>, <a href="#st_005fstoneimpulse">st_stoneimpulse</a>, <a href="#st_005fquake">st_quake</a>,

24304

<a href="#st_005fmirror">st_mirror</a>, <a href="#st_005ffourswitch">st_fourswitch</a>, <a href="#st_005fvolcano">st_volcano</a>. A third category

24305

switches temporarily into another state on the first message sent when the

24306

boulder reaches a grid and switches back on the second message sent when the

24307

boulder gives up like <a href="#st_005fpassage">st_passage</a>, <a href="#st_005fflat">st_flat</a>, <a href="#st_005flightpassenger">st_lightpassenger</a>.

24308

24309

Items getting beneath a moving boulder may react like on any other stone move

24310

on top of them. Additionally <a href="#it_005fblocker">it_blocker</a> will be released to grow again

24311

to a blocking stone.

24312

24313

Boulder stones fall into <a href="#fl_005fabyss">fl_abyss</a>, but cross <a href="#fl_005fwater">fl_water</a>

24314

unchanged.

24315

24316

<a href="#it_005fmagicwand">it_magicwand</a> and lasers reverse its orientation. An <a href="#st_005factorimpulse">st_actorimpulse</a>

24317

reverts the orientation if the boulder hits it frontally. An <a href="#st_005frotator">st_rotator</a>

24318

changes its orientation according to the rotator’s direction. An

24319

<a href="#st_005fstoneimpulse">st_stoneimpulse</a> pushes a boulder away.

24320

24321

24322

<dt> Attributes:</dt>

24323

<dd>

24324

24325

24326

</dd>

24327

<dt> orientation,   values: <code>NORTH</code>, <code>EAST</code>, <code>SOUTH</code>, <code>WEST</code>;   default: <code>NORTH</code></dt>

24328

<dd>The orientation of the boulder that is shown by its arrow. It determines the

24329

direction that the boulder will take on its next move.

24330

</dd>

24331

<dt> counterclock   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

24332

<dd>The standard turning direction is clockwise. Use this attribute to revert the

24333

direction.

24334

</dd>

24335

</dl>

24336

24337

</dd>

24338

<dt> Messages:</dt>

24339

<dd>

24340

24341

24342

</dd>

24343

<dt> orientate,   value type: direction</dt>

24344

<dd>Change the orientation to the given orientation value. The <a href="#st_005ffourswitch">st_fourswitch</a>

24345

provides a compatible action which allows you to set a boulder as

24346

target and this message as action.

24347

</dd>

24348

24349

<dd>Turn orientation in turning direction as defined by attribute

24350

‘<samp>counterclock</samp>’.

24351

</dd>

24352

<dt> turnback</dt>

24353

<dd>Turn orientation in opposite turning direction as defined by attribute

24354

‘<samp>counterclock</samp>’.

24355

</dd>

24356

24357

<dd>Turn orientation into the reverse of the current orientation.

24358

</dd>

24359

</dl>

24360

24361

</dd>

24362

<dt> Action:</dt>

24363

<dd>none

24364

24365

</dd>

24366

<dt> Variants:</dt>

24367

<dd>

24368

24369

<dt> <img src="images/st_boulder.png" alt="images/st_boulder"> st_boulder

24370

</dt>

24371

<dt> <img src="images/st_boulder.png" alt="images/st_boulder"> st_boulder_n: orientation = <code>NORTH</code>

24372

</dt>

24373

<dt> <img src="images/st_boulder_b.png" alt="images/st_boulder_b"> st_boulder_e: orientation = <code>EAST</code>

24374

</dt>

24375

<dt> <img src="images/st_boulder_c.png" alt="images/st_boulder_c"> st_boulder_s: orientation = <code>SOUTH</code>

24376

</dt>

24377

<dt> <img src="images/st_boulder_d.png" alt="images/st_boulder_d"> st_boulder_w: orientation = <code>WEST</code>

24378

</dt>

24379

</dl>

24380

24381

</dd>

24382

</dl>

24383

24384

24385

24386

24387

24388

24389

24390

24391

24392

24393

24394

24395

24396

24397

24398

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

24399

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

24400

24401

</tr></table>

24402

24403

24404

24405

24406

A movable, floor building stone of various flavors.

24407

24408

This very common stone is well known in its default flavor <code>"wood"</code>. But it

24409

exists in the flavors <code>"hay"</code> and <code>"rock"</code>, too. The flavor

24410

<code>"wood"</code> has a random wood tile orientation. You can set wooden boxes of

24411

given tile orientation by the variants <code>st_box_wood_h</code> and

24412

<code>st_box_wood_v</code>.

24413

24414

The flavors <code>"wood"</code> and <code>"hay"</code> may originate from a growing

24415

<a href="#it_005fseed">it_seed</a>. Due to the <a href="#Snapshot-Principle">Snapshot Principle</a> special box variants exist

24416

just for usage in level initialization: <code>st_box_wood_growing</code> and

24417

<code>st_box_hay_growing</code>.

24418

24419

All variants can easily be pushed around, do press <a href="#it_005ftrigger">it_trigger</a>s and do fall

24420

into <a href="#fl_005fabyss">fl_abyss</a>, <a href="#fl_005fwater">fl_water</a> and <a href="#fl_005fswamp">fl_swamp</a> by building a framed floor

24421

of the kind indicated by their ‘<samp>flavor</samp>’ attribute. All boxes will fall on

24422

the first occasion. Even if they receive two push impulses at the same time by

24423

<a href="#ot_005fwire">ot_wire</a> they fall on the first grid. Thus it is impossible to push a box

24424

over a ditch. Boxes will fall if the floor beneath them vanishes. E.g. an

24425

<a href="#it_005fbomb">it_bomb</a> explosion beneath a box may change the floor to <a href="#fl_005fabyss">fl_abyss</a> or

24426

a flood stream may change the floor to <a href="#fl_005fwater">fl_water</a>. In all these cases the

24427

box above falls immediately building its kind of floor.

24428

24429

Note that all boxes do actively support <a href="#Flood-Spreading">Flood Spreading</a>. That means that

24430

they let an arriving flood stream flow beneath them. In case the floor beneath

24431

the box is floodable it will change to water and the box will fall. The new built

24432

floor itself conserves the flood stream feature and will let the stream flood

24433

neighboring floodable floors, too. (see section <a href="#fl_005fwood">fl_wood</a>, <a href="#fl_005fhay">fl_hay</a>, <a href="#fl_005frock">fl_rock</a>).

24434

24435

The box flavors do differ in some small but essential features. Whereas the

24436

flavors <code>"wood"</code> and <code>"rock"</code> do cause an <a href="#it_005fbomb">it_bomb</a> to explode

24437

when being pushed over it, a <code>"hay"</code> flavored box does not ignite bombs.

24438

24439

According to their flavor <code>"wood"</code> and <code>"hay"</code> will burn on fire.

24440

But <code>"rock"</code> flavored boxes are fire resistant and fire blocking.

24441

24442

24443

<dt> Attributes:</dt>

24444

<dd>

24445

24446

<dt> flavor   values: <code>"wood"</code>, <code>"hay"</code>, <code>"rock"</code>;   default: <code>"wood"</code>;   access: read only</dt>

24447

<dt> secure   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

24448

<dd>This attribute is inherited to a floor build by a falling box and guarantees

24449

then secure fire burning.

24450

</dd>

24451

</dl>

24452

24453

</dd>

24454

<dt> Messages: none</dt>

24455

<dt> Action: none</dt>

24456

<dt> Variants:</dt>

24457

<dd>

24458

24459

<dt> <img src="images/st_box_wood.png" alt="images/st_box_wood"> st_box: flavor=<code>"wood"</code>

24460

</dt>

24461

<dt> <img src="images/st_box_wood.png" alt="images/st_box_wood"> st_box_wood: flavor=<code>"wood"</code>

24462

</dt>

24463

<dt> <img src="images/st_box_wood.png" alt="images/st_box_wood"> st_box_wood_h: flavor=<code>"wood"</code>

24464

</dt>

24465

<dt> <img src="images/st_box_wood_2.png" alt="images/st_box_wood_2"> st_box_wood_v: flavor=<code>"wood"</code>

24466

</dt>

24467

<dt> <img src="images/st_box_wood_growing.png" alt="images/st_box_wood_growing"> st_box_wood_growing: flavor=<code>"wood"</code>

24468

</dt>

24469

<dt> <img src="images/st_box_hay.png" alt="images/st_box_hay"> st_box_hay: flavor=<code>"hay"</code>

24470

</dt>

24471

<dt> <img src="images/st_box_hay_4.png" alt="images/st_box_hay_4"> st_box_hay_growing: flavor=<code>"hay"</code>

24472

</dt>

24473

<dt> <img src="images/st_box_rock.png" alt="images/st_box_rock"> st_box_rock: flavor=<code>"rock"</code>

24474

</dt>

24475

</dl>

24476

24477

</dd>

24478

</dl>

24479

24480

24481

24482

24483

24484

24485

24486

24487

24488

24489

24490

24491

24492

24493

24494

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

24495

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

24496

24497

</tr></table>

24498

24499

<h3 class="subsection">9.5.8 st_brake</h3>

24500

24501

24502

The brake stone can be used to block a running <a href="#st_005fboulder">st_boulder</a> or a

24503

<a href="#st_005flightpassenger">st_lightpassenger</a>, what likely has given this object its name. But unlike

24504

all other blocking stones the brake can be picked up as an item by actors and

24505

dropped anywhere else.

24506

24507

When an actor passes a brake stone, rolling on the floor or while jumping, it

24508

will pick up the object like other items. The brake will be added as an

24509

<a href="#it_005fbrake">it_brake</a> to its inventory. Unlike other items the brake can be dropped

24510

even on grids that are already occupied by an item. But you can not drop the

24511

brake beneath another stone like a <a href="#it_005fseed">it_seed</a>.

24512

24513

On dropping the brake item it transforms immediately back to an <a href="#st_005fbrake">st_brake</a>

24514

without killing the item positioned on the grid. Just one exception is a brake

24515

being dropped on top of an <a href="#it_005fblocker">it_blocker</a> what results in an elimination of

24516

the blocker. On the other hand a brake stone will press an <a href="#it_005ftrigger">it_trigger</a>

24517

beneath, what makes the brake item a portable trigger key.

24518

24519

The brake stone explodes when it is exposed to laser light or a <a href="#it_005fbomb">it_bomb</a>

24520

explosion on a direct neighbor grid.

24521

24522

24523

<dt> Attributes: none</dt>

24524

<dt> Messages: none</dt>

24525

<dt> Action: none</dt>

24526

<dt> Variants: none</dt>

24527

24528

<dt> <img src="images/st_brake.png" alt="images/st_brake"> st_brake

24529

</dt>

24530

</dl>

24531

</dd>

24532

</dl>

24533

24534

24535

24536

24537

24538

24539

24540

24541

24542

24543

24544

24545

24546

24547

24548

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

24549

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

24550

24551

</tr></table>

24552

24553

<h3 class="subsection">9.5.9 st_break</h3>

24554

24555

24556

A stone of various flavors that is breakable under various conditions. The

24557

stone may be breakable by actors of some kind, with or without an item, by an

24558

igniting explosion on a neighboring grid and in most cases by laser light.

24559

Besides being breakable the stone is a standard stone. The different flavors let

24560

this stone appear in quite different outlooks.

24561

24562

The flavor <code>"plain"</code> is a grey stone that is breakable by any actor hit

24563

with a revealed <a href="#it_005fhammer">it_hammer</a> and by a laser beam hitting any side.

24564

24565

The flavors <code>"black"</code> and <code>"white"</code> look similar to the <code>"plain"</code>

24566

variant just with a small colored ball sitting on top. But these variants are

24567

just breakable by any actors of matching color. Of course the actors need a

24568

revealed <a href="#it_005fhammer">it_hammer</a>. Laser beams do break the stone, too.

24569

24570

The flavor <code>"oxydc"</code> looks like a cracked <a href="#st_005foxyd">st_oxyd</a> of flavor

24571

<code>"c"</code>. Like the <code>"plain"</code> variant it is breakable by any actor hit

24572

with a revealed <a href="#it_005fhammer">it_hammer</a> and by a laser beam hitting any side.

24573

24574

The flavor <code>"boulder"</code> looks like a yellowish version of flavor

24575

<code>"oxydc"</code>. It is breakable under the same conditions plus additionally by

24576

an <a href="#st_005fboulder">st_boulder</a> hitting on one of its sides.

24577

24578

The flavor <code>"bug"</code> looks like an <a href="#st_005fflat">st_flat</a> with a bug symbol on top.

24579

It is just breakable by an <a href="#ac_005fbug">ac_bug</a>. No other actor and no laser light will

24580

break it.

24581

24582

The flavor <code>"laser"</code> looks identical to an <a href="#st_005fflat">st_flat</a>. It is not

24583

breakable by actors. Just laser light beams on one of its faces will break this

24584

variant.

24585

24586

All but the variant <code>"bug"</code> will break on neighboring ignitions like those

24587

caused by an exploding <a href="#it_005fdynamite">it_dynamite</a> on a direct neighboring position or an

24588

exploding black <a href="#it_005fbomb">it_bomb</a> on a diagonal neighboring position.

24589

24590

24591

<dt> Attributes:</dt>

24592

<dd>

24593

24594

<dt> flavor   values: <code>"plain"</code>, <code>"black"</code>, <code>"white"</code>, <code>"oxydc"</code>, <code>"boulder"</code>, <code>"bug"</code>, <code>"laser"</code>;   default: <code>"plain"</code>;   access: read only</dt>

24595

</dl>

24596

24597

</dd>

24598

<dt> Messages:</dt>

24599

24600

<dt> ignite</dt>

24601

<dd>Break stone with exception of flavor <code>"bug"</code>.

24602

</dd>

24603

</dl>

24604

24605

</dd>

24606

<dt> Action: none</dt>

24607

<dt> Variants:</dt>

24608

<dd>

24609

24610

<dt> <img src="images/st_break_plain.png" alt="images/st_break_plain"> st_break: flavor=<code>"plain"</code>

24611

</dt>

24612

<dt> <img src="images/st_break_plain.png" alt="images/st_break_plain"> st_break_plain: flavor=<code>"plain"</code>

24613

</dt>

24614

<dt> <img src="images/st_break_black.png" alt="images/st_break_black"> st_break_black: flavor=<code>"black"</code>

24615

</dt>

24616

<dt> <img src="images/st_break_white.png" alt="images/st_break_white"> st_break_white: flavor=<code>"white"</code>

24617

</dt>

24618

<dt> <img src="images/st_break_oxydc.png" alt="images/st_break_oxydc"> st_break_oxydc: flavor=<code>"oxydc"</code>

24619

</dt>

24620

<dt> <img src="images/st_break_boulder.png" alt="images/st_break_boulder"> st_break_boulder: flavor=<code>"boulder"</code>

24621

</dt>

24622

<dt> <img src="images/st_break_bug.png" alt="images/st_break_bug"> st_break_bug: flavor=<code>"bug"</code>

24623

</dt>

24624

<dt> <img src="images/st_flat.png" alt="images/st_flat"> st_break_laser: flavor=<code>"laser"</code>

24625

</dt>

24626

</dl>

24627

24628

</dd>

24629

</dl>

24630

24631

24632

24633

24634

24635

24636

24637

24638

24639

24640

24641

24642

24643

24644

24645

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

24646

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

24647

24648

</tr></table>

24649

24650

<h3 class="subsection">9.5.10 st_brownpyramid</h3>

24651

24652

24653

A brown gray pyramid shaped stone. This stone is just standard stone besides

24654

the fact that it can be destroyed by an <a href="#ot_005fcannonball">ot_cannonball</a> emitted by an

24655

<a href="#st_005fspitter">st_spitter</a> that happens to fall on its top.

24656

24657

24658

<dt> Variants:</dt>

24659

24660

<dt> <img src="images/st_brownpyramid.png" alt="images/st_brownpyramid"> st_brownpyramid

24661

</dt>

24662

</dl>

24663

</dd>

24664

</dl>

24665

24666

24667

24668

24669

24670

24671

24672

24673

24674

24675

24676

24677

24678

24679

24680

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

24681

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

24682

24683

</tr></table>

24684

24685

<h3 class="subsection">9.5.11 st_chameleon</h3>

24686

24687

24688

A stone that has no own image but mimics the floor beneath. Thus it is fairly

24689

invisible. But as it shows the same image as the floor it hides items and even

24690

actors on the grid. The stone is hovering, thus it does not press any

24691

<a href="#it_005ftrigger">it_trigger</a> and lets pass any actors and laser light, too.

24692

24693

Please make rare usage of this stone in Enigma 1.1* as the current display

24694

engine does not really support this stone. All dynamic floors and floor changes

24695

do cause faulty displays. Thus use it currently only in patterns without any

24696

floor dynamics.

24697

24698

24699

<dt> Variants:</dt>

24700

24701

<dt> <img src="images/fl_white.png" alt="images/fl_white"> st_chameleon

24702

</dt>

24703

</dl>

24704

</dd>

24705

</dl>

24706

24707

24708

24709

24710

24711

24712

24713

24714

24715

24716

24717

24718

24719

24720

24721

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

24722

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

24723

24724

</tr></table>

24725

24726

<h3 class="subsection">9.5.12 st_charge</h3>

24727

24728

24729

An electrical charger for actors. The image reflects the sign of the

24730

‘<samp>charge</samp>’ attribute.

24731

24732

Any actor hitting this stone will recharge its <a href="#charge">charge</a> attribute to the

24733

value given by the stone’s ‘<samp>charge</samp>’ attribute.

24734

24735

The stone itself does not cause any electrical forces. It is neither attracting

24736

nor repelling for charged actors. Electrical forces applied to actors just

24737

depend on the charges of different actors and the global attribute

24738

<a href="#ElectricStrength">ElectricStrength</a>.

24739

24740

24741

<dt> Attributes:</dt>

24742

<dd>

24743

24744

<dt> charge   values: floating point numbers;   default: <code>0.0</code></dt>

24745

<dd>The charge applied to hitting actors.

24746

</dd>

24747

</dl>

24748

24749

</dd>

24750

<dt> Messages: none</dt>

24751

<dt> Action: none</dt>

24752

<dt> Variants:</dt>

24753

<dd>

24754

24755

<dt> <img src="images/st_charge_zero.png" alt="images/st_charge_zero"> st_charge: charge = <code>0.0</code>

24756

</dt>

24757

<dt> <img src="images/st_charge_zero.png" alt="images/st_charge_zero"> st_charge_zero: charge = <code>0.0</code>

24758

</dt>

24759

<dt> <img src="images/st_charge_plus.png" alt="images/st_charge_plus"> st_charge_plus: charge = <code>+1.0</code>

24760

</dt>

24761

<dt> <img src="images/st_charge_minus.png" alt="images/st_charge_minus"> st_charge_minus: charge = <code>-1.0</code>

24762

</dt>

24763

</dl>

24764

24765

</dd>

24766

</dl>

24767

24768

24769

24770

24771

24772

24773

24774

24775

24776

24777

24778

24779

24780

24781

24782

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

24783

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

24784

24785

</tr></table>

24786

24787

<h3 class="subsection">9.5.13 st_chess</h3>

24788

24789

24790

A chess stone is like a chess knight. It exists in the two colors black and

24791

white, it can jump and make a chess knight move. It can even beat stones at

24792

the target position.

24793

24794

A black chess can only be moved with a black marble, a white one with white

24795

marbles. The jump direction is given by the marble hit direction. It moves

24796

two grid steps into the direction, into which other movable stones move just one

24797

grid, plus one grid step vertical. The vertical direction is given by the

24798

marbles vertical velocity component.

24799

24800

When there is a chess stone of opposite color or an <a href="#st_005fthief">st_thief</a> at the target

24801

position of a knight move, this stone is captured and destroyed.

24802

24803

When hit with a revealed <a href="#it_005fmagicwand">it_magicwand</a>, a chess stone changes color.

24804

24805

Chess stones fall into <a href="#fl_005fabyss">fl_abyss</a> and sink in <a href="#fl_005fswamp">fl_swamp</a>, but cross

24806

<a href="#fl_005fwater">fl_water</a> undamaged.

24807

24808

A chess stone that jumps onto a <a href="#fl_005fthief">fl_thief</a> captures and inactivates the

24809

thief.

24810

24811

Chess stones can’t jump over or into fire (see <a href="#Fire-Spreading">Fire Spreading</a>). At least,

24812

a chess knight is brave enough not to panic when fire starts to burn beneath.

24813

Note that fire can’t ignite the floor below a chess stone. In this

24814

context it acts like an immovable stone. In the same sense, they don’t act on

24815

stone impulses of <a href="#st_005fstoneimpulse">st_stoneimpulse</a> or <a href="#it_005fpuller">it_puller</a>.

24816

24817

24818

<dt> Attributes:</dt>

24819

<dd>

24820

24821

<dt> color   values: <code>BLACK</code>, <code>WHITE</code>;   default: <code>BLACK</code></dt>

24822

<dd>The color of the chess stone

24823

</dd>

24824

<dt> movable   values: <code>true</code>;   default: <code>true</code>   See section <a href="#movable">movable</a></dt>

24825

<dd>Read only attribute that states the ability of a chess stone to move.

24826

</dd>

24827

</dl>

24828

24829

</dd>

24830

<dt> Messages:</dt>

24831

<dd>

24832

24833

24834

<dd>Flip the color of the stone.

24835

</dd>

24836

<dt> move,   value type: position;   values: <code>NNE</code>, <code>NEE</code>, <code>SEE</code>, <code>SSE</code>, <code>SSW</code>, <code>SWW</code>, <code>NWW</code>, <code>NNW</code></dt>

24837

<dd>Jump into the given direction.

24838

</dd>

24839

</dl>

24840

24841

</dd>

24842

<dt> Action: none</dt>

24843

<dt> Variants:</dt>

24844

<dd>

24845

24846

<dt> <img src="images/st_chess_black.png" alt="images/st_chess_black"> st_chess: color = <code>BLACK</code>

24847

</dt>

24848

<dt> <img src="images/st_chess_black.png" alt="images/st_chess_black"> st_chess_black: color = <code>BLACK</code>

24849

</dt>

24850

<dt> <img src="images/st_chess_white.png" alt="images/st_chess_white"> st_chess_white: color = <code>WHITE</code>

24851

</dt>

24852

</dl>

24853

24854

</dd>

24855

</dl>

24856

24857

24858

24859

24860

24861

24862

24863

24864

24865

24866

24867

24868

24869

24870

24871

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

24872

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

24873

24874

</tr></table>

24875

24876

<h3 class="subsection">9.5.14 st_coinslot</h3>

24877

24878

24879

A switch that is activated by insertion of an <a href="#it_005fcoin">it_coin</a>. Just actors

24880

assigned to a player can insert coins out of their item inventory by hitting

24881

the coinslot with the coin being the first item. Depending on the coin type the

24882

coinslot remains in state ‘<samp>ON</samp>’ for a given ‘<samp>interval</samp>’ before switching

24883

back to state ‘<samp>OFF</samp>’. Multiple inserted coins do prolong the activity

24884

interval.

24885

24886

Standard not ‘<samp>instant</samp>’ coinslots do activate after the insertion process

24887

of the coin. No additional coins can be inserted while another coin is being

24888

inserted. This prevents unintended multiple coin insertions. On the other hand

24889

the player has to insert additional coins early enough to prolong the active

24890

state without temporarily switching back to ‘<samp>OFF</samp>’ state. If the first

24891

interval runs off while the next coin did not yet finish its insertion the

24892

coinslot will first switch ‘<samp>OFF</samp>’ and switch ‘<samp>ON</samp>’ when the next coin

24893

is completely inserted.

24894

24895

The activity interval of a coin insertion depends on the type of the coin. For

24896

each type you can set the interval by the ‘<samp>interval_*</samp>’ attributes. You

24897

can reject the insertion of a coin type by setting its interval to

24898

‘<samp>COIN_REJECT</samp>’. The coin will not be taken from the players inventory. By

24899

a value of ‘<samp>COIN_IGNORE</samp>’ on the interval attribute the coinslot will fetch

24900

the coin but will not act at all.

24901

24902

Coinslots configured as ‘<samp>instant</samp>’ do activate immediately when the actor

24903

hits the stone. On every actor hit a coin is inserted independent of the last

24904

insertion.

24905

24906

The ‘<samp>state</samp>’ of a coinslot can be requested but it can not be set, neither

24907

by attribute nor by messages.

24908

24909

24910

<dt> Attributes:</dt>

24911

<dd>

24912

24913

<dt> state,   values: <code>ON</code>, <code>OFF</code>;   default: <code>OFF</code>; access: <code>read only</code>   See section <a href="#state">state</a></dt>

24914

<dd>Current activity state of the coinslot.

24915

</dd>

24916

<dt> instant   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

24917

<dd>A default coinslot switches to active state after insertion of a coin and allows

24918

the insertion of just one coin at a time.

24919

</dd>

24920

<dt> interval_s   values: positive number, <code>COIN_REJECT</code>, <code>COIN_IGNORE</code>;   default: <code>3.0</code></dt>

24921

<dd>Number of additional active seconds on insertion of a small <a href="#it_005fcoin">it_coin</a>.

24922

</dd>

24923

<dt> interval_m   values: positive number, <code>COIN_REJECT</code>, <code>COIN_IGNORE</code>;   default: <code>6.0</code></dt>

24924

<dd>Number of additional active seconds on insertion of a medium <a href="#it_005fcoin">it_coin</a>.

24925

</dd>

24926

<dt> interval_l   values: positive number, <code>COIN_REJECT</code>, <code>COIN_IGNORE</code>;   default: <code>12.0</code></dt>

24927

<dd>Number of additional active seconds on insertion of a large <a href="#it_005fcoin">it_coin</a>.

24928

</dd>

24929

</dl>

24930

24931

</dd>

24932

<dt> Messages: none</dt>

24933

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

24934

<dt> Variants:</dt>

24935

<dd>

24936

24937

<dt> <img src="images/st_coinslot.png" alt="images/st_coinslot"> st_coinslot: instant = <code>false</code>

24938

</dt>

24939

<dt> <img src="images/st_coinslot.png" alt="images/st_coinslot"> st_coinslot_instant: instant = <code>true</code>

24940

</dt>

24941

</dl>

24942

24943

</dd>

24944

</dl>

24945

24946

24947

24948

24949

24950

24951

24952

24953

24954

24955

24956

24957

24958

24959

24960

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

24961

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

24962

24963

</tr></table>

24964

24965

<h3 class="subsection">9.5.15 st_darkglass</h3>

24966

24967

24968

A metal framed semi transparent glass stone. It exists in static, movable and

24969

hollow variants and is just transparent to laser light in its hollow variant.

24970

Like other <a href="#Transparent-Stones">Transparent Stones</a> it is passable for invisible actors as long

24971

as it is not ‘<samp>movable</samp>’.

24972

24973

A <a href="#st_005flightpassenger">st_lightpassenger</a> in state ‘<samp>OFF</samp>’ looks identical to a darkglass

24974

stone

24975

24976

24977

<dt> Attributes:</dt>

24978

<dd>

24979

24980

<dt> hollow   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: read only   See section <a href="#hollow">hollow</a></dt>

24981

<dt> movable   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: read only   See section <a href="#movable">movable</a></dt>

24982

</dl>

24983

24984

</dd>

24985

<dt> Messages: none</dt>

24986

<dt> Variants:</dt>

24987

24988

<dt> <img src="images/st_darkglass.png" alt="images/st_darkglass"> st_darkglass: hollow = <code>false</code>, movable = <code>false</code>

24989

</dt>

24990

<dt> <img src="images/st_darkglass.png" alt="images/st_darkglass"> st_darkglass_hollow: hollow = <code>true</code>, movable = <code>false</code>

24991

</dt>

24992

<dt> <img src="images/st_darkglass.png" alt="images/st_darkglass"> st_darkglass_movable: hollow = <code>false</code>, movable = <code>true</code>

24993

</dt>

24994

</dl>

24995

24996

</dd>

24997

</dl>

24998

24999

25000

25001

25002

25003

25004

25005

25006

25007

25008

25009

25010

25011

25012

25013

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

25014

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

25015

25016

</tr></table>

25017

25018

<h3 class="subsection">9.5.16 st_death</h3>

25019

25020

25021

Shatters any <a href="#ac_005fmarble">ac_marble</a> and <a href="#ac_005fpearl">ac_pearl</a> that hits or even just touches

25022

it. Just marbles and pearls protected by an activated <a href="#it_005fumbrella">it_umbrella</a> will

25023

bounce unharmed as other actors do which will not die anyway.

25024

25025

Death stones can be configured by the ‘<samp>invisible</samp>’ attribute to

25026

be hidden while being idle. When hit by an actor any death stone becomes

25027

temporary visible. An actor with unbroken standard <a href="#it_005fglasses">it_glasses</a> in its

25028

inventory will be able to spot invisible death stones.

25029

25030

The level author can configure <a href="#it_005fglasses">it_glasses</a> by elimination of

25031

‘<samp>SPOT_DEATH</samp>’ not to show invisible death stones. With the global attribute

25032

<a href="#ExtralifeGlasses">ExtralifeGlasses</a> even glasses generated by laser lighting an

25033

<a href="#it_005fextralife">it_extralife</a> can be configured not to show invisible actorimpulse stones.

25034

25035

A death stone can also be movable. Of course ball like actors can not push it.

25036

But other actors can push it. A movable death stone can be connected by an

25037

<a href="#ot_005fwire">ot_wire</a> to another movable stone that allows to control it. Furtheron

25038

all stones emitting stone impulses like <a href="#st_005fstoneimpulse">st_stoneimpulse</a>, <a href="#st_005frotator">st_rotator</a>,

25039

<a href="#st_005flightpassenger">st_lightpassenger</a> can move it. And finally a pushing <a href="#st_005fboulder">st_boulder</a>

25040

will move it until an obstacle stops the death stone.

25041

25042

A movable death stone looks identical to the static default version. But from

25043

time to time it will show its animation and can thus be identified by the user.

25044

The interval of the animations is determined by the attribute ‘<samp>interval</samp>’,

25045

but will randomly vary up to 20% from the given value. When the ‘<samp>interval</samp>’

25046

equals zero no animation will reveal the movable death. But any <a href="#it_005fglasses">it_glasses</a>

25047

capable of ‘<samp>SPOT_DEATH</samp>’ will show the movable death in a lighter stone

25048

color than the static ones.

25049

25050

A ‘<samp>movable</samp>’ death can not be ‘<samp>invisible</samp>’ at the same time. If you set

25051

both attributes the last attribute set wins and resets the first one.

25052

25053

25054

<dt> Attributes:</dt>

25055

25056

<dt> state,   values: <code>ON</code>, <code>OFF</code>;   default: <code>OFF</code>; access: <code>read only</code>   See section <a href="#state">state</a></dt>

25057

<dd>Current activity state of the death stone. A stone is usually activated by

25058

a hitting actor.

25059

</dd>

25060

<dt> invisible   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

25061

<dd>Invisible death stones show only when hit by an actor or been toggled by a message.

25062

Setting this attribute to ‘<samp>true</samp>’ sets ‘<samp>movable</samp>’ to ‘<samp>false</samp>’.

25063

</dd>

25064

<dt> movable   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   See section <a href="#movable">movable</a></dt>

25065

<dd>Movable death stone. Setting this attribute to ‘<samp>true</samp>’ sets ‘<samp>invisible</samp>’

25066

to ‘<samp>false</samp>’.

25067

</dd>

25068

<dt> interval   values: positive number;   default: <code>10.0</code></dt>

25069

<dd>Number of seconds to show animation on movable death.

25070

</dd>

25071

</dl>

25072

25073

</dd>

25074

<dt> Messages:</dt>

25075

25076

<dt> toggle   See section <a href="#toggle">toggle</a></dt>

25077

<dd>Temporarily activate the stone to show its animation and to get visible for this

25078

period.

25079

</dd>

25080

</dl>

25081

25082

</dd>

25083

<dt> Action: none</dt>

25084

<dt> Variants:</dt>

25085

25086

<dt> <img src="images/st_death.png" alt="images/st_death"> st_death: invisible = <code>false</code>

25087

</dt>

25088

<dt> <img src="images/fl_white.png" alt="images/fl_white"> st_death_invisible: invisible = <code>true</code>

25089

</dt>

25090

<dt> <img src="images/st_death_light.png" alt="images/st_death_light"> st_death_movable: movable = <code>true</code>

25091

</dt>

25092

</dl>

25093

25094

</dd>

25095

</dl>

25096

25097

25098

25099

25100

25101

25102

25103

25104

25105

25106

25107

25108

25109

25110

25111

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

25112

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

25113

25114

</tr></table>

25115

25116

<h3 class="subsection">9.5.17 st_disco</h3>

25117

25118

25119

A free passable stone, which darkens everything that is underneath the stone.

25120

It looks like a tinted glass that occurs in several shades. It likely got its

25121

name from the possibility to switch between the shade grades.

25122

25123

The disco stone comes in three variants, ‘<samp>LIGHT</samp>’, ‘<samp>MEDIUM</samp>’ and

25124

‘<samp>DARK</samp>’. The dark variant is pure black, that shows neither actors, items or

25125

the floor. You can switch between these variants by messages and state attribute

25126

access. The messages <code>"lighten"</code> and <code>"darken"</code> change the shade

25127

by one degree. The message <code>"signal"</code> turns the disco light full on or off,

25128

independent of the previous state. The standard <code>"toggle"</code> switches from

25129

light -> medium -> dark -> light.

25130

25131

Note: unlike the old API versions of this stone, it does no longer support

25132

recursive shading of neighboring disco stones. Make use of object groups by

25133

<a href="#Object-Naming">Object Naming</a> to shade groups of arbitrary composition by a single message.

25134

25135

25136

<dt> Attributes:</dt>

25137

25138

<dt> state,   values: <code>LIGHT</code>, <code>MEDIUM</code>, <code>DARK</code>;   default: <code>LIGHT</code>   See section <a href="#state">state</a></dt>

25139

<dd>The shading grade.

25140

</dd>

25141

</dl>

25142

25143

</dd>

25144

<dt> Messages:</dt>

25145

25146

<dt> lighten</dt>

25147

<dd>Lighten by one degree.

25148

</dd>

25149

<dt> darken</dt>

25150

<dd>Darken by one degree.

25151

</dd>

25152

<dt> signal   See section <a href="#signal">signal</a></dt>

25153

<dd>Switch to ‘<samp>LIGHT</samp>’ on a value of <code>1</code>. Switch to ‘<samp>DARK</samp>’ on a value

25154

of <code>0</code>.

25155

</dd>

25156

<dt> toggle   See section <a href="#toggle">toggle</a></dt>

25157

<dd>Darken by degree or switch from ‘<samp>DARK</samp>’ to ‘<samp>LIGHT</samp>’

25158

</dd>

25159

</dl>

25160

25161

</dd>

25162

<dt> Action: none</dt>

25163

<dt> Variants:</dt>

25164

25165

<dt> <img src="images/st_disco.png" alt="images/st_disco"> st_disco: state = <code>LIGHT</code>

25166

</dt>

25167

<dt> <img src="images/st_disco.png" alt="images/st_disco"> st_disco_light: state = <code>LIGHT</code>

25168

</dt>

25169

<dt> <img src="images/st_disco_2.png" alt="images/st_disco_2"> st_disco_medium: state = <code>MEDIUM</code>

25170

</dt>

25171

<dt> <img src="images/st_disco_3.png" alt="images/st_disco_3"> st_disco_dark: state = <code>DARK</code>

25172

</dt>

25173

</dl>

25174

25175

</dd>

25176

</dl>

25177

25178

25179

25180

25181

25182

25183

25184

25185

25186

25187

25188

25189

25190

25191

25192

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

25193

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

25194

25195

</tr></table>

25196

25197

<h3 class="subsection">9.5.18 st_dispenser</h3>

25198

25199

25200

An item dispenser in some item flavors.

25201

25202

On every actor hit the dispenser adds a new item given by the attribute

25203

‘<samp>flavor</samp>’, namely <a href="#it_005fbomb">it_bomb</a> in color black or white, <a href="#it_005fdynamite">it_dynamite</a>

25204

or <a href="#it_005fextralife">it_extralife</a> to the inventory of the actor’s owner. Of course an item

25205

will just be added if the inventory is capable of adding a further item.

25206

Additionally the dispenser’s ‘<samp>stock</samp>’ must supply a further item. The

25207

default stock of 1000 items should be enough for usual demands. But you can

25208

limit the supply to just a few counted items. This ‘<samp>stock</samp>’ attribute gets

25209

decremented every time an actor takes an item.

25210

25211

The dispenser stone does break on adjacent <a href="#it_005fbomb">it_bomb</a> explosions and

25212

adjacent dispenser stone breaks. On its break it will itself cause adjacent

25213

<a href="#it_005fdynamite">it_dynamite</a> to ignite, <a href="#it_005fbomb">it_bomb</a> positioned beneath itself to

25214

explode, and of course neighboring dispensers to break. Dispenser stones will

25215

neither break on actor hits, even with a revealed hammer, nor on laser light

25216

beams.

25217

25218

25219

<dt> Attributes:</dt>

25220

<dd>

25221

25222

<dt> flavor   values: <code>"bombblack"</code>, <code>"bombwhite"</code>, <code>"dynamite"</code>, <code>"extralife"</code>;   default: <code>"bombblack"</code>;</dt>

25223

<dt> stock,   values: integer numbers;   default: <code>1000</code>:   See section <a href="#state">state</a></dt>

25224

</dl>

25225

25226

</dd>

25227

<dt> Messages: none</dt>

25228

<dt> Action: none</dt>

25229

<dt> Variants:</dt>

25230

<dd>

25231

25232

<dt> <img src="images/st_dispenser_bombblack.png" alt="images/st_dispenser_bombblack"> st_dispenser: flavor=<code>"bombblack"</code>

25233

</dt>

25234

<dt> <img src="images/st_dispenser_bombblack.png" alt="images/st_dispenser_bombblack"> st_dispenser_bombblack: flavor=<code>"bombblack"</code>

25235

</dt>

25236

<dt> <img src="images/st_dispenser_bombwhite.png" alt="images/st_dispenser_bombwhite"> st_dispenser_bombwhite: flavor=<code>"bombwhite"</code>

25237

</dt>

25238

<dt> <img src="images/st_dispenser_dynamite.png" alt="images/st_dispenser_dynamite"> st_dispenser_dynamite: flavor=<code>"dynamite"</code>

25239

</dt>

25240

<dt> <img src="images/st_dispenser_extralife.png" alt="images/st_dispenser_extralife"> st_dispenser_extralife: flavor=<code>"extralife"</code>

25241

</dt>

25242

</dl>

25243

25244

</dd>

25245

</dl>

25246

25247

25248

25249

25250

25251

25252

25253

25254

25255

25256

25257

25258

25259

25260

25261

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

25262

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

25263

25264

</tr></table>

25265

25266

25267

25268

25269

Doors are stones that let actors pass or block them to enter the grid, depending

25270

on their state. Doors can be opened and closed by the standard set of messages.

25271

Doors do not open or close instantly. They need a small amount of time. Actors

25272

can pass only doors that are completely open.

25273

25274

There are several flavors of doors. The variants <code>"a"</code> to <code>"c"</code>

25275

represent grid filling block doors. Flavor <code>"a"</code> looks in the closed state

25276

like <a href="#st_005foxyd">st_oxyd</a> of flavor <code>"a"</code> and in the opened state like an

25277

<a href="#st_005fgrate">st_grate</a> of flavor <code>"cross"</code>. Flavor <code>"b"</code> looks in the closed

25278

state like <a href="#st_005fflat">st_flat</a> but opens to an invisible, free passable, but still

25279

existing and grid blocking stone. Flavor <code>"c"</code> looks in the closed state

25280

like <a href="#st_005fflat">st_flat</a> and in the opened state like an <a href="#st_005fgrate">st_grate</a> of flavor

25281

<code>"framed"</code>. The flavor <code>"d"</code> represents a faces based door, that

25282

opens or blocks just the given faces of the grid. Currently just the

25283

combinations of two parallel aligned door faces, aka horizontal and vertical

25284

doors, are supported.

25285

25286

As door grids can be entered on unfaced sides you should block these faces by

25287

impassable stones. If you do not block these entries or even allow marbles to

25288

warp into a door, the actors will be free to leave the doors even if they are

25289

closed. But marbles will shatter on the door grid when doors are closed. This

25290

behaviour is a legacy Enigma feature.

25291

25292

Doors are stones that are even present if they are not visible in the <code>OPEN</code>

25293

state. This means you can not push or move any other stone through an open door.

25294

The <a href="#st_005fblocker">st_blocker</a> is a quite compatible door alternative that allows stones

25295

to pass in its open state.

25296

25297

All doors are hovering and will not press <a href="#it_005ftrigger">it_trigger</a>s. Thus you can detect

25298

passing actors by positioning a trigger beneath a door. Doors will neither press

25299

<a href="#fl_005fbridge">fl_bridge</a> and will thus take no influence on the bridge.

25300

25301

Laser light will pass any open door, but will be blocked by closed faces. Closed

25302

doors of type <code>"d"</code> let light pass if the faces are parallel aligned to

25303

the light without intervening the light.

25304

25305

Just doors of type <code>"d"</code> allow an actor to knock on its closed faces.

25306

This causes an action that might open the door or do anything else. A common

25307

target is <a href="#st_005fjamb">st_jamb</a> that evaluated the color of the knocking actor.

25308

25309

Doors do support <a href="#Flood-Spreading">Flood Spreading</a> and <a href="#Fire-Spreading">Fire Spreading</a> through open

25310

faces and generally in ‘<samp>OPEN</samp>’ state.

25311

25312

25313

<dt> Attributes:</dt>

25314

25315

<dt> state,   values: <code>OPEN</code>, <code>CLOSED</code>;   default: <code>CLOSED</code>;   See section <a href="#state">state</a></dt>

25316

<dd>The open state of the door. On read access it reports if the door is completely

25317

opened and passable for actors. Note that a door reaches the state ‘<samp>OPEN</samp>’

25318

after the finish of the opening animation, what is an essential amount of time

25319

after the initiating <code>"open"</code> message. But on a <code>"close"</code> message the

25320

state turns immediately to ‘<samp>CLOSED</samp>’ as actors are blocked immediately. On

25321

write access a state change causes a proper message and may occur with a delay,

25322

too.

25323

25324

</dd>

25325

<dt> flavor   values: <code>"a"</code>, <code>"b"</code>, <code>"c"</code>, <code>"d"</code>;   default: <code>"d"</code></dt>

25326

<dd>Representing different door types as described above. Block based flavors

25327

<code>"a"</code>, <code>"b"</code>, <code>"c"</code> and the face based flavor <code>"d"</code>.

25328

25329

</dd>

25330

<dt> faces   values: string;   default: <code>"nesw"</code></dt>

25331

<dd>Describes the door faces of the stone. The string is a substring of

25332

<code>"nesw"</code> listing the faces. The sequence of the sides, north, east, south,

25333

west, is guaranteed on read access but arbitrary on write access. Note that

25334

the supported face combinations depend on the flavor. All but flavor <code>"d"</code>

25335

do always provide all 4 faces. Flavor <code>"d"</code> currently supports the face

25336

combinations <code>"ns"</code> and <code>"ew"</code>, in other words horizontal and

25337

vertical aligned door faces, with the first combination being the default.

25338

25339

</dd>

25340

</dl>

25341

25342

</dd>

25343

<dt> Messages:</dt>

25344

25345

<dt> open   See section <a href="#open">open</a></dt>

25346

<dd>Opens a closed door or reverses the process of a closing door.

25347

</dd>

25348

<dt> close   See section <a href="#close">close</a></dt>

25349

<dd>Closes an open door or reverses the process of an opening door.

25350

</dd>

25351

<dt> signal   See section <a href="#signal">signal</a></dt>

25352

<dd>Opens at value ‘<samp>1</samp>’, and closes at value ‘<samp>0</samp>’.

25353

</dd>

25354

</dl>

25355

25356

</dd>

25357

<dt> Action:</dt>

25358

<dd>Just flavor <code>"d"</code> doors will perform an action on an actor touching a face

25359

of a closed door. The action value will be the actor object, which can be

25360

evaluated on its kind. This action value fits the ‘<samp>hit</samp>’ messages of

25361

objects like <a href="#st_005fjamb">st_jamb</a>.

25362

25363

</dd>

25364

<dt> Variants:</dt>

25365

25366

<tr><td width="8%"><img src="images/st_oxyda.png" alt="images/st_oxyda"></td><td width="42%">st_door_a: flavor = <code>"a"</code>, state = <code>CLOSED</code></td><td width="8%"><img src="images/st_grate_cross.png" alt="images/st_grate_cross"></td><td width="42%">st_door_a: flavor = <code>"a"</code>, state = <code>OPEN</code></td></tr>

25367

<tr><td width="8%"><img src="images/st_flat.png" alt="images/st_flat"></td><td width="42%">st_door_b: flavor = <code>"b"</code>, state = <code>CLOSED</code></td><td width="8%"><img src="images/fl_white.png" alt="images/fl_white"></td><td width="42%">st_door_b: flavor = <code>"b"</code>, state = <code>OPEN</code></td></tr>

25368

<tr><td width="8%"><img src="images/st_flat.png" alt="images/st_flat"></td><td width="42%">st_door_c: flavor = <code>"c"</code>, state = <code>CLOSED</code></td><td width="8%"><img src="images/st_grate_framed.png" alt="images/st_grate_framed"></td><td width="42%">st_door_c: flavor = <code>"c"</code>, state = <code>OPEN</code></td></tr>

25369

<tr><td width="8%"><img src="images/st_door_d_ns_7.png" alt="images/st_door_d_ns_7"></td><td width="42%">st_door_d: flavor = <code>"d"</code>, faces = <code>"ns"</code>, state = <code>CLOSED</code></td><td width="8%"><img src="images/st_door_d_ns.png" alt="images/st_door_d_ns"></td><td width="42%">st_door_d: flavor = <code>"d"</code>, faces = <code>"ns"</code>, state = <code>OPEN</code></td></tr>

25370

<tr><td width="8%"><img src="images/st_door_d_ew_g.png" alt="images/st_door_d_ew_g"></td><td width="42%">st_door_d: flavor = <code>"d"</code>, faces = <code>"ew"</code>, state = <code>CLOSED</code></td><td width="8%"><img src="images/st_door_d_ew.png" alt="images/st_door_d_ew"></td><td width="42%">st_door_d: flavor = <code>"d"</code>, faces = <code>"ew"</code>, state = <code>OPEN</code></td></tr>

25371

</table>

25372

25373

</dd>

25374

</dl>

25375

25376

25377

25378

25379

25380

25381

25382

25383

25384

25385

25386

25387

25388

25389

25390

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

25391

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

25392

25393

</tr></table>

25394

25395

25396

25397

25398

A stone that mimics other stones, but does not act like them.

25399

25400

In contrast to <a href="#st_005fmagic">st_magic</a> the fake stone does not transform but remains

25401

all time a passive variant of the stone that it models. The stone does look

25402

like another stone of the kind given by the attribute ‘<samp>flavor</samp>’. The fake

25403

stone may even mimic state dependent behaviour with state dependent models

25404

and animations.

25405

25406

The flavor <code>"quake"</code> mimics a <a href="#st_005fquake">st_quake</a> including the pulsing

25407

animation on actor hits and state changes, but does not cause any <a href="#st_005foxyd">st_oxyd</a>

25408

to close.

25409

25410

The flavors <code>"oxyda"</code>, <code>"oxydb"</code>, <code>"oxydc"</code>, <code>"oxydd"</code>,

25411

<code>"oxyde"</code> mimic <a href="#st_005foxyd">st_oxyd</a> of appropriate flavor, but they are just

25412

passive stones. Nevertheless they are aware of a state ‘<samp>OPEN</samp>’ and will

25413

display the corresponding base image of the open oxyd stone, of course without

25414

any color spot.

25415

25416

25417

<dt> Attributes:</dt>

25418

<dd>

25419

25420

<dt> flavor   values: <code>"quake"</code>, <code>"oxyda"</code>, <code>"oxydb"</code>, <code>"oxydc"</code>, <code>"oxydd"</code>, <code>"oxyde"</code>;   default: <code>"quake"</code>;</dt>

25421

<dt> state,   values: <code>CLOSED</code>, <code>OPEN</code>;   default: <code>CLOSED</code>:   See section <a href="#state">state</a></dt>

25422

</dl>

25423

25424

</dd>

25425

<dt> Messages: none</dt>

25426

<dt> Action: none</dt>

25427

<dt> Variants:</dt>

25428

25429

<tr><td width="8%"><img src="images/st_oxydb.png" alt="images/st_oxydb"> st_fake_quake: flavor=<code>"quake"</code>, state=<code>IDLE</code></td><td width="42%"><img src="images/st_quake_3.png" alt="images/st_quake_3"> st_fake_quake: flavor=<code>"quake"</code>, state=<code>ACTIVE</code></td></tr>

25430

<tr><td width="8%"><img src="images/st_oxyda.png" alt="images/st_oxyda"> st_fake_oxyda: flavor=<code>"oxyda"</code>, state=<code>CLOSED</code></td><td width="42%"><img src="images/st_oxyda_open.png" alt="images/st_oxyda_open"> st_fake_oxyda: flavor=<code>"oxyda"</code>, state=<code>OPEN</code></td></tr>

25431

<tr><td width="8%"><img src="images/st_oxydb.png" alt="images/st_oxydb"> st_fake_oxydb: flavor=<code>"oxydb"</code>, state=<code>CLOSED</code></td><td width="42%"><img src="images/st_oxydb_open.png" alt="images/st_oxydb_open"> st_fake_oxydb: flavor=<code>"oxydb"</code>, state=<code>OPEN</code></td></tr>

25432

<tr><td width="8%"><img src="images/st_oxydc.png" alt="images/st_oxydc"> st_fake_oxydc: flavor=<code>"oxydc"</code>, state=<code>CLOSED</code></td><td width="42%"><img src="images/st_oxydc_open.png" alt="images/st_oxydc_open"> st_fake_oxydc: flavor=<code>"oxydc"</code>, state=<code>OPEN</code></td></tr>

25433

<tr><td width="8%"><img src="images/st_oxydd.png" alt="images/st_oxydd"> st_fake_oxydd: flavor=<code>"oxydd"</code>, state=<code>CLOSED</code></td><td width="42%"><img src="images/st_oxydb_open.png" alt="images/st_oxydb_open"> st_fake_oxydd: flavor=<code>"oxydd"</code>, state=<code>OPEN</code></td></tr>

25434

<tr><td width="8%"><img src="images/st_oxydb.png" alt="images/st_oxydb"> st_fake_oxyde: flavor=<code>"oxyde"</code>, state=<code>CLOSED</code></td><td width="42%"><img src="images/st_oxydb_open.png" alt="images/st_oxydb_open"> st_fake_oxyde: flavor=<code>"oxyde"</code>, state=<code>OPEN</code></td></tr>

25435

</table>

25436

25437

</dd>

25438

</dl>

25439

25440

25441

25442

25443

25444

25445

25446

25447

25448

25449

25450

25451

25452

25453

25454

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

25455

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

25456

25457

</tr></table>

25458

25459

<h3 class="subsection">9.5.21 st_flash</h3>

25460

25461

25462

A stone symbolized by a yellow flash, that forwards actors hits as a force to

25463

matching partner actors.

25464

25465

Just <a href="#ac_005fmarble">ac_marble</a> actors are affected. A black hitting marble will push

25466

the first white marble, and vice versa. The hitting marble’s velocity is

25467

multiplied to a distortion matrix given by four single attributes. The default

25468

matrix does maintain the direction. The resulting vector is again multiplied

25469

by a linear strength factor. The resulting force vector is applied to the

25470

partner marble. If no matching marble exists no forces are applied. The hitting

25471

marble bounces on the flash stone as on any other standard stone.

25472

25473

25474

<dt> Attributes:</dt>

25475

<dd>

25476

25477

<dt> hit_strength   values: floating point numbers;   default: <code>20.0</code>;   See section <a href="#hit_005f_002a">hit_*</a></dt>

25478

<dt> hit_distortion_xx   values: floating point numbers;   default: <code>1.0</code>;   See section <a href="#hit_005f_002a">hit_*</a></dt>

25479

<dt> hit_distortion_xy   values: floating point numbers;   default: <code>0.0</code>;   See section <a href="#hit_005f_002a">hit_*</a></dt>

25480

<dt> hit_distortion_yx   values: floating point numbers;   default: <code>0.0</code>;   See section <a href="#hit_005f_002a">hit_*</a></dt>

25481

<dt> hit_distortion_yy   values: floating point numbers;   default: <code>1.0</code>;   See section <a href="#hit_005f_002a">hit_*</a></dt>

25482

</dl>

25483

25484

</dd>

25485

<dt> Messages: none</dt>

25486

<dt> Action: none</dt>

25487

<dt> Variants:</dt>

25488

25489

<dt> <img src="images/st_flash.png" alt="images/st_flash"> st_flash:

25490

</dt>

25491

</dl>

25492

</dd>

25493

</dl>

25494

25495

25496

25497

25498

25499

25500

25501

25502

25503

25504

25505

25506

25507

25508

25509

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

25510

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

25511

25512

</tr></table>

25513

25514

25515

25516

25517

A flat gypsum stone with many variants and features.

25518

25519

Besides the standard features of a movable, hollow or breakable stone the flat

25520

stone provides some very special features and variant transformations.

25521

25522

Movable and breakable flat stones will fall into <a href="#fl_005fabyss">fl_abyss</a>. But just the

25523

movable variant will fall into <a href="#fl_005fwater">fl_water</a> and <a href="#fl_005fswamp">fl_swamp</a>.

25524

25525

A laser beam will shatter a breakable variant. Further on it transforms a plain flat

25526

stone, and just this variant, into a cracked variant, which is visually

25527

distinguishable by small cracks. But further laser light will not break a

25528

cracked variant. Ignitions and explosions will shatter breakable, cracked and

25529

movable variants. An actor with a revealed <a href="#it_005fhammer">it_hammer</a> is able to shatter

25530

both the breakable and the cracked variant. Note that the visually

25531

indistinguishable <a href="#st_005fbreak">st_break</a>_laser breaks on a laser hit, too, but without

25532

being breakable by actors.

25533

25534

An actor with a revealed <a href="#it_005fpencil">it_pencil</a> will mark a plain or movable variant

25535

as burnable what is hinted for the player by a fire symbol on the flat stone

25536

surface. A burnable flat stone burns on fire, but just the immovable, burnable

25537

variant reacts on heating by self destruction. All burnable variants can be

25538

cleaned by an actor hit with an <a href="#it_005fbrush">it_brush</a>. The fire symbol vanishes and

25539

the stone does not longer react on fire and heating.

25540

25541

Last but not least an <a href="#st_005fboulder">st_boulder</a> hitting a plain or hollow variant of the

25542

flat stone toggles the ‘<samp>hollow</samp>’ attribute twice within a short period. The

25543

time is sufficient for a fast actor to pass an otherwise solid plain flat stone.

25544

By proper fast redirection of the boulder a user can enforce permanent changes

25545

of the hollow state.

25546

25547

25548

<dt> Attributes:</dt>

25549

<dd>

25550

25551

<dt> hollow   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: read only   See section <a href="#hollow">hollow</a></dt>

25552

<dt> movable   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: read only   See section <a href="#movable">movable</a></dt>

25553

<dt> breakable   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: read only   See section <a href="#breakable">breakable</a></dt>

25554

<dt> burnable   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: read only   See section <a href="#burnable">burnable</a></dt>

25555

</dl>

25556

25557

</dd>

25558

<dt> Messages: none</dt>

25559

<dt> Action: none</dt>

25560

<dt> Variants:</dt>

25561

25562

<dt> <img src="images/st_flat.png" alt="images/st_flat"> st_flat:

25563

</dt>

25564

<dt> <img src="images/st_flat.png" alt="images/st_flat"> st_flat_hollow: hollow=<code>true</code>

25565

</dt>

25566

<dt> <img src="images/st_flat.png" alt="images/st_flat"> st_flat_movable: movable=<code>"true"</code>

25567

</dt>

25568

<dt> <img src="images/st_flat.png" alt="images/st_flat"> st_flat_breakable: breakable=<code>"true"</code>

25569

</dt>

25570

<dt> <img src="images/st_flat_cracked.png" alt="images/st_flat_cracked"> st_flat_cracked:

25571

</dt>

25572

<dt> <img src="images/st_flat_fire.png" alt="images/st_flat_fire"> st_flat_burnable: burnable=<code>"true"</code>

25573

</dt>

25574

<dt> <img src="images/st_flat_fire.png" alt="images/st_flat_fire"> st_flat_moveburnable: movable=<code>"true"</code>, burnable=<code>"true"</code>

25575

</dt>

25576

<dt> <img src="images/st_flat_break.png" alt="images/st_flat_break"> st_flat_breaking: breakable=<code>"true"</code>

25577

</dt>

25578

</dl>

25579

</dd>

25580

</dl>

25581

25582

25583

25584

25585

25586

25587

25588

25589

25590

25591

25592

25593

25594

25595

25596

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

25597

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

25598

25599

</tr></table>

25600

25601

<h3 class="subsection">9.5.23 st_floppy</h3>

25602

25603

25604

A switch that is activated by insertion of an <a href="#it_005ffloppy">it_floppy</a>. Just actors

25605

assigned to a player can insert a floppy out of their item inventory by hitting

25606

the floppy switch with a floppy being the first item.

25607

25608

On a second hit the switch is deactivated and the inserted floppy is returned

25609

to the players inventory.

25610

25611

Floppy stones are often used as openers for an adjacent <a href="#st_005fdoor">st_door</a> that is

25612

declared as its ‘<samp>target</samp>’. But there is the inherent danger that an actor

25613

passing the door accidentially hits the neighboring floppy stone, causing the floppy

25614

to be pulled out again and the door to be closed immediately. Of couse this

25615

would shatter any <a href="#ac_005fmarble">ac_marble</a> or <a href="#ac_005fpearl">ac_pearl</a>. But a ‘<samp>secure</samp>’ floppy

25616

stone checks that the hitting actor is not positioned on one of the floppy stones

25617

target positions. It refuses any actions caused by such critical hits. Note

25618

that in case the target is a callback function that closes the adjacent door,

25619

there will be still no protection. A floppy stone with ‘<samp>secure</samp>’ value

25620

‘<samp>false</samp>’ would accept any hits and shatter marbles as it has been standard

25621

on older Enigma releases and is still in modes besides Enigma.

25622

25623

25624

<dt> Attributes:</dt>

25625

<dd>

25626

25627

<dt> state,   values: <code>ON</code>, <code>OFF</code>;   default: <code>OFF</code>;   See section <a href="#state">state</a></dt>

25628

<dd>Current activity state of the floppy stone.

25629

</dd>

25630

<dt> secure   values: <code>true</code>, <code>false</code>;   default: <code>true</code></dt>

25631

<dd>Protect actors on target positions by neglecting their hits.

25632

</dd>

25633

</dl>

25634

25635

</dd>

25636

<dt> Messages:</dt>

25637

<dd>

25638

25639

<dt> signal   See section <a href="#signal">signal</a></dt>

25640

<dd>Switches on at value ‘<samp>1</samp>’, and off at value ‘<samp>0</samp>’.

25641

</dd>

25642

<dt> on   See section <a href="#on">on</a></dt>

25643

<dt> off   See section <a href="#off">off</a></dt>

25644

</dl>

25645

25646

</dd>

25647

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

25648

<dt> Variants:</dt>

25649

25650

<dt> <img src="images/st_floppy_off.png" alt="images/st_floppy_off"> st_floppy with state=<code>OFF</code>

25651

</dt>

25652

<dt> <img src="images/st_floppy_on.png" alt="images/st_floppy_on"> st_floppy with state=<code>ON</code>

25653

</dt>

25654

</dl>

25655

</dd>

25656

</dl>

25657

25658

25659

25660

25661

25662

25663

25664

25665

25666

25667

25668

25669

25670

25671

25672

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

25673

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

25674

25675

</tr></table>

25676

25677

<h3 class="subsection">9.5.24 st_fourswitch</h3>

25678

25679

25680

A switch that points into one of the four orientations and turning on every

25681

switching event. The most common event is an actor hitting this stone. But

25682

<a href="#st_005fboulder">st_boulder</a> will trigger this switch, too. Of course other objects can send

25683

messages on actions to make this switch turning.

25684

25685

When turning its pointer on a switching event it performs the action given by

25686

the ‘<samp>action/target</samp>’-pair. This can be either a common pair or a

25687

state/orientation dependent pair allowing you to issue different messages

25688

dependent on the pointing orientation.

25689

25690

25691

<dt> Attributes:</dt>

25692

<dd>

25693

25694

25695

</dd>

25696

<dt> state,   values: <code>NORTH</code>, <code>EAST</code>, <code>SOUTH</code>, <code>WEST</code>;   default: <code>NORTH</code>   See section <a href="#state">state</a></dt>

25697

<dt> counterclock   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

25698

<dd>The standard turning direction is clockwise. Use this attribute to revert the

25699

direction.

25700

</dd>

25701

<dt> inverse   See section <a href="#inverse">inverse</a></dt>

25702

<dd>Note that the action value is inverted in its boolean interpretation. This means

25703

that an inverted action value is not the reverse orientation and should

25704

not be used as an orientation value at all.

25705

</dd>

25706

</dl>

25707

25708

</dd>

25709

<dt> Messages:</dt>

25710

<dd>

25711

25712

<dt> signal   See section <a href="#signal">signal</a></dt>

25713

<dd>Note that the fourswitch reacts just on value <code>1</code>. Values of <code>0</code> are

25714

simply ignored. Use message toggle if you need turns on any message value.

25715

</dd>

25716

<dt> toggle   See section <a href="#toggle">toggle</a></dt>

25717

<dd>Note that a toggle turns the fourswitch independent of a message value.

25718

</dd>

25719

</dl>

25720

25721

</dd>

25722

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

25723

<dd>Performs an action on each turn. If just a pair of global ‘<samp>target/action</samp>’

25724

attributes are given, the action message is sent to the target with a value of

25725

the new orientation. This value suits any message of the target that expects

25726

an orientation value, and the <a href="#signal">signal</a> message, that translates the

25727

orientation value to a 1 for ‘<samp>NORTH</samp>’, ‘<samp>SOUTH</samp>’ and a 0 for

25728

‘<samp>EAST</samp>’, ‘<samp>WEST</samp>’.

25729

25730

If state dependent target/action pairs are given instead, namely

25731

‘<samp>target_0/action_0</samp>’ for the state ‘<samp>WEST</samp>’,... , ‘<samp>target_3/action_3</samp>’

25732

for the state ‘<samp>NORTH</samp>’, two actions will be performed: first for the state

25733

representing the old orientation the given action messages will be sent with

25734

a value of 0, then for the state representing the new orientation the given

25735

action messages will be sent with a value of 1. This allows you to switch on

25736

and off alternative sources by a fourswitch.

25737

25738

</dd>

25739

<dt> Variants:</dt>

25740

25741

<dt> <img src="images/st_fourswitch.png" alt="images/st_fourswitch"> st_fourswitch

25742

</dt>

25743

</dl>

25744

</dd>

25745

</dl>

25746

25747

25748

25749

25750

25751

25752

25753

25754

25755

25756

25757

25758

25759

25760

25761

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

25762

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

25763

25764

</tr></table>

25765

25766

<h3 class="subsection">9.5.25 st_ghost</h3>

25767

25768

25769

An invisible stone that transforms into a visible stone on actor hits with

25770

properly revealed tools.

25771

25772

Similar to <a href="#st_005fmagic">st_magic</a> this stone does transform to another kind, but it

25773

is initially always invisible, what gave it its name. Invisibility is not

25774

equal to laser transparency. In fact one flavor of this ghost stone is not

25775

laser transparent. And invisibility does not mean that an invisible actor can

25776

pass a ghost stone. (see section <a href="#Transparent-Stones">Transparent Stones</a>)

25777

25778

The ghost stone transforms to another stone of the kind given by its

25779

attribute ‘<samp>flavor</samp>’. The tool necessary to cause this transformation depends

25780

on the flavor.

25781

25782

The flavor <code>"purplemarble"</code> transforms to an <a href="#st_005fpurplemarble">st_purplemarble</a> on a hit

25783

with a revealed <a href="#it_005fbrush">it_brush</a>. This flavor is not laser transparent.

25784

25785

The flavor <code>"greenbrown"</code> transforms to an <a href="#st_005fgreenbrown">st_greenbrown</a> on a hit

25786

with a revealed <a href="#it_005fmagicwand">it_magicwand</a>.

25787

25788

The flavor <code>"break"</code> transforms to an <a href="#st_005fbreak">st_break</a> of variant

25789

‘<samp>st_break_oxydc</samp>’ on a hit with a revealed <a href="#it_005fbrush">it_brush</a>.

25790

25791

25792

25793

<dt> Attributes:</dt>

25794

<dd>

25795

25796

<dt> flavor   values: <code>"purplemarble"</code>, <code>"greenbrown"</code>, <code>"break"</code>;   default: <code>"purplemarble"</code>;   access: read only</dt>

25797

</dl>

25798

25799

</dd>

25800

<dt> Messages: none</dt>

25801

<dt> Action: none</dt>

25802

<dt> Variants:</dt>

25803

25804

<tr><td width="8%"><img src="images/fl_white.png" alt="images/fl_white"></td><td width="52%">st_ghost: flavor=<code>"purplemarble"</code></td><td width="40%"><img src="images/st_purplemarble.png" alt="images/st_purplemarble"></td></tr>

25805

<tr><td width="8%"><img src="images/fl_white.png" alt="images/fl_white"></td><td width="52%">st_ghost_purplemarble: flavor=<code>"purplemarble"</code></td><td width="40%"><img src="images/st_purplemarble.png" alt="images/st_purplemarble"></td></tr>

25806

<tr><td width="8%"><img src="images/fl_white.png" alt="images/fl_white"></td><td width="52%">st_ghost_greenbrown: flavor=<code>"greenbrown"</code></td><td width="40%"><img src="images/st_greenbrown.png" alt="images/st_greenbrown"></td></tr>

25807

<tr><td width="8%"><img src="images/fl_white.png" alt="images/fl_white"></td><td width="52%">st_ghost_break: flavor=<code>"break"</code></td><td width="40%"><img src="images/st_break_plain.png" alt="images/st_break_plain"></td></tr>

25808

</table>

25809

</dd>

25810

</dl>

25811

25812

25813

25814

25815

25816

25817

25818

25819

25820

25821

25822

25823

25824

25825

25826

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

25827

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

25828

25829

</tr></table>

25830

25831

<h3 class="subsection">9.5.26 st_grate</h3>

25832

25833

25834

Hovering metal grate in different flavors that let all actors pass but block

25835

stones from moving over a grid position.

25836

25837

The different flavors are just for decorative purposes, but <code>"cross"</code>

25838

variant looks identical to an open <a href="#st_005fdoor">st_door</a> of flavor <code>"a"</code>, whereas

25839

<code>"framed"</code> variant looks identical to an open <a href="#st_005fdoor">st_door</a> of flavor

25840

<code>"b"</code>.

25841

25842

In contrast to opened doors grates do bounce actors that are flying due to a

25843

jump.

25844

25845

As a hovering stone grates do not press <a href="#it_005ftrigger">it_trigger</a>s and let laser light

25846

pass. Grates allow <a href="#Flood-Spreading">Flood Spreading</a> and <a href="#Fire-Spreading">Fire Spreading</a>, too.

25847

25848

25849

<dt> Attributes:</dt>

25850

<dd>

25851

25852

<dt> flavor   values: <code>"cross"</code>, <code>"framed"</code>;   default: <code>"cross"</code></dt>

25853

</dl>

25854

25855

</dd>

25856

<dt> Messages: none</dt>

25857

<dt> Action: none</dt>

25858

<dt> Variants:</dt>

25859

25860

<dt> <img src="images/st_grate_cross.png" alt="images/st_grate_cross"> st_grate: flavor=<code>"cross"</code>

25861

</dt>

25862

<dt> <img src="images/st_grate_cross.png" alt="images/st_grate_cross"> st_grate_cross: flavor=<code>"cross"</code>

25863

</dt>

25864

<dt> <img src="images/st_grate_framed.png" alt="images/st_grate_framed"> st_grate_framed: flavor=<code>"framed"</code>

25865

</dt>

25866

</dl>

25867

25868

</dd>

25869

</dl>

25870

25871

25872

25873

25874

25875

25876

25877

25878

25879

25880

25881

25882

25883

25884

25885

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

25886

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

25887

25888

</tr></table>

25889

25890

<h3 class="subsection">9.5.27 st_greenbrown</h3>

25891

25892

25893

A mainly brown stone that is just a standard stone besides

25894

the fact that it can originate from two other objects.

25895

25896

On one hand an <a href="#it_005fseed">it_seed</a> of flavor <code>"fake"</code> will grow to a standard,

25897

unmovable greenbrown. Just for level initialization purpose you can even set

25898

a variant ‘<samp>st_greenbrown_growing</samp>’ due to the <a href="#Snapshot-Principle">Snapshot Principle</a>.

25899

25900

On the other hand a <a href="#st_005fghost">st_ghost</a> of flavor <code>"greenbrown"</code> will transform

25901

to standard, unmovable greenbrown on an actor hit with a revealed

25902

<a href="#it_005fmagicwand">it_magicwand</a>.

25903

25904

25905

<dt> Variants:</dt>

25906

25907

<dt> <img src="images/st_greenbrown.png" alt="images/st_greenbrown"> st_greenbrown

25908

</dt>

25909

<dt> <img src="images/st_greenbrown.png" alt="images/st_greenbrown"> st_greenbrown_hollow

25910

</dt>

25911

<dt> <img src="images/st_greenbrown.png" alt="images/st_greenbrown"> st_greenbrown_movable

25912

</dt>

25913

<dt> <img src="images/st_greenbrown_4.png" alt="images/st_greenbrown_4"> st_greenbrown_growing

25914

</dt>

25915

</dl>

25916

</dd>

25917

</dl>

25918

25919

25920

25921

25922

25923

25924

25925

25926

25927

25928

25929

25930

25931

25932

25933

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

25934

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

25935

25936

</tr></table>

25937

25938

25939

25940

25941

A block of ice is a movable stone that freezes some items when being pushed

25942

over them. Of course a floor of <a href="#fl_005fwater">fl_water</a> will freeze, too, when ice is

25943

being pushed over it. But a block of ice can be destroyed by explosions and by

25944

heating fire leaving either <a href="#fl_005fice">fl_ice</a> or <a href="#fl_005fwater">fl_water</a>.

25945

25946

When an ice block without frozen item is pushed onto a grid with a

25947

<a href="#freezable">freezable</a> item, the ice will freeze the item and will move it beneath

25948

itself on subsequent pushes. All items that the user can carry in his inventory

25949

are <a href="#freezable">freezable</a> and even some <a href="#Static-Items">Static Items</a> like <a href="#it_005fmagnet">it_magnet</a>,

25950

<a href="#it_005fspringboard">it_springboard</a>, etc. But a few items react in a special manner when an

25951

ice block is pushed onto them:

25952

<ul>

25953

<li> <a href="#it_005fsquashed">it_squashed</a> and <a href="#it_005fburnable">it_burnable</a>, with the exception of

25954

‘<samp>it_burnable_oil</samp>’, dissolve to nothing.

25955

</li><li> <a href="#it_005fcrack">it_crack</a> will vanish as the ice is putty for the cracked floors

25956

</li><li> <a href="#it_005fseed">it_seed</a> will not start growing, even though the ice is pushed as a

25957

solid stone on top.

25958

</li><li> <a href="#it_005fbomb">it_bomb</a> will explode and destroy the ice block as well as the floor.

25959

</li><li> <a href="#it_005fdynamite">it_dynamite</a> is very special - a burning dynamite gets extinguished

25960

by an ice block and becomes frozen in its idle state.

25961

</li></ul>

25962

25963

But what happens when an ice block with a frozen item gets pushed onto a grid

25964

with another item? The stronger item wins and survives beneath the ice block

25965

on the new position while the weaker item will be killed. The sequence from

25966

weak to strong is quite simple:

25967

<ul>

25968

<li> static items that get anyway wiped out by an ice block

25969

</li><li> <a href="#Liftable-Items">Liftable Items</a>

25970

</li><li> <a href="#portable">portable</a> items that are not <a href="#liftable">liftable</a>

25971

</li><li> <a href="#freezable">freezable</a> items that are not <a href="#portable">portable</a>

25972

</li><li> <a href="#Static-Items">Static Items</a> that are not <a href="#freezable">freezable</a>

25973

</li></ul>

25974

When the two items are of the same category the already frozen item wins. This

25975

last rule ensures that the user can not free frozen items by dropping a liftable

25976

item out of his inventory in front of an ice block before pushing it.

25977

25978

An ice block looks like a bluish version of <a href="#st_005frawglass">st_rawglass</a>. But it has just

25979

one feature in common. It is transparent to laser light. Of course you can not

25980

freeze laser beams, even though they are implemented in the item layer. Laser

25981

light will interact even with frozen items and can ignite <a href="#it_005fdynamite">it_dynamite</a> or

25982

<a href="#it_005fbomb">it_bomb</a>. Even though being light transparent invisible actors can not

25983

pass it (see section <a href="#Transparent-Stones">Transparent Stones</a>).

25984

25985

Ice blocks shatter on nearby <a href="#it_005fbomb">it_bomb</a> and <a href="#it_005fdynamite">it_dynamite</a> explosions and

25986

on <a href="#ot_005fcannonball">ot_cannonball</a> hits. The ice will spread to the four direct neighboring

25987

grid positions and will cover these and the originating position with

25988

<a href="#fl_005fice">fl_ice</a>. Just <a href="#fl_005fabyss">fl_abyss</a> will not be covered by this ice floor and

25989

remains unchanged. Thus an exploding bomb leaves an <a href="#fl_005fabyss">fl_abyss</a> at its

25990

position, even when an ice blocks shatters nearby.

25991

25992

A fire starting to burn on a direct neighbor position will eventually melt the

25993

ice block by its <a href="#Heat_002dTransformation">Heat-Transformation</a>. The ice will melt to an

25994

<a href="#fl_005fwater">fl_water</a>. Just in case the ice block melts over an <a href="#fl_005fabyss">fl_abyss</a> the

25995

floor remains unchanged. The ice heating is no secure feature, as the heat burst

25996

occurs just once for each fire. Thus a user may be able to push an ice block

25997

aside a fire without heat transformation. Furtheron the melting takes time.

25998

Any intermediate nearby explosion can still shatter the melting ice block.

25999

26000

26001

<dt> Messages:</dt>

26002

<dd>

26003

26004

<dt> ignite   See section <a href="#ignite">ignite</a></dt>

26005

<dd>Shatter the ice block.

26006

</dd>

26007

<dt> heat   See section <a href="#heat">heat</a></dt>

26008

<dd>Melt the ice block

26009

</dd>

26010

</dl>

26011

26012

</dd>

26013

<dt> Variants:</dt>

26014

26015

<dt> <img src="images/st_ice.png" alt="images/st_ice"> st_ice

26016

</dt>

26017

</dl>

26018

</dd>

26019

</dl>

26020

26021

26022

26023

26024

26025

26026

26027

26028

26029

26030

26031

26032

26033

26034

26035

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

26036

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

26037

26038

</tr></table>

26039

26040

26041

26042

26043

A colored door jamb that allows coupled opening and closing on adjacent

26044

<a href="#st_005fdoor">st_door</a>s. Especially doors of flavor <code>"d"</code> can be opened by proper

26045

colored actors by door knocking.

26046

26047

The stone looks like 4 brown door jambs each with a colored ball on top. It fits

26048

to the 2 faced <code>"d"</code> variant of <a href="#st_005fdoor">st_door</a>. These doors can be

26049

configured to send the message <code>"hit"</code> to the adjacent jambs as their

26050

targets. Whenever an actor knocks the door, the jamb receives the message and

26051

checks the actor for matching color. On success it sends opening signals to

26052

the door being knocked and to a door being located on the opposite side of the

26053

jamb. Additionally doors located on the remaining two adjacent positions of the

26054

jamb will receive a closing signal. E.g.:

26055

26056

<table><tr><td> </td><td><pre class="example">ti["n"] = {"st_door_d", "north", target="jamb", action="hit"}

26057

ti["e"] = {"st_door_d", "east", target="jamb", action="hit"}

26058

ti["s"] = {"st_door_d", "south", target="jamb", action="hit"}

26059

ti["w"] = {"st_door_d", "west", target="jamb", action="hit"}

26060

ti["J"] = {"st_jamb", "jamb"}

26061

ti["@"] = {"st_marble"}

26062

wo(ti, " ", {

26063

" n ",

26064

"wJe",

26065

" s@"

26066

}

26067

</pre></td></tr></table>

26068

26069

The black marble touching the east door will open the east and the west door,

26070

and will close the north and south door at the same time. The black marble

26071

touching the south door will open the south and the north door, and will close

26072

the west and east door.

26073

26074

26075

<dt> Attributes:</dt>

26076

<dd>

26077

26078

<dt> color   values: <code>BLACK</code>, <code>WHITE</code>;   default: <code>BLACK</code></dt>

26079

</dl>

26080

26081

</dd>

26082

<dt> Messages:</dt>

26083

<dd>

26084

26085

26086

<dd>The message value must be an object reference of an actor. The color of the

26087

actor must match the jamb color to cause an action. The sender’s position must

26088

either match the x or the y coordinate of the jamb, too.

26089

26090

</dd>

26091

<dt> signal   See section <a href="#signal">signal</a></dt>

26092

<dd>This message is just kept for backward compatibility issues. Do not use it in

26093

new API levels as it depends on other internal attributes not set for new API

26094

levels.

26095

</dd>

26096

</dl>

26097

26098

</dd>

26099

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

26100

<dt> Variants:</dt>

26101

<dd>

26102

26103

<dt> <img src="images/st_jamb_black.png" alt="images/st_jamb_black"> st_jamb: color=<code>BLACK</code>

26104

</dt>

26105

<dt> <img src="images/st_jamb_black.png" alt="images/st_jamb_black"> st_jamb_black: color=<code>BLACK</code>

26106

</dt>

26107

<dt> <img src="images/st_jamb_white.png" alt="images/st_jamb_white"> st_jamb_white: color=<code>WHITE</code>

26108

</dt>

26109

</dl>

26110

26111

</dd>

26112

</dl>

26113

26114

26115

26116

26117

26118

26119

26120

26121

26122

26123

26124

26125

26126

26127

26128

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

26129

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

26130

26131

</tr></table>

26132

26133

26134

26135

26136

A switch that is activated by insertion of an <a href="#it_005fkey">it_key</a>. Just actors

26137

assigned to a player can insert a key out of their item inventory by hitting

26138

the key switch with a key being the first item. Just keys with a matching

26139

‘<samp>code</samp>’ are accepted.

26140

26141

On a second hit the switch is deactivated and the inserted key is returned

26142

to the player’s inventory.

26143

26144

Key stones are often used as openers for an adjacent <a href="#st_005fdoor">st_door</a> that is

26145

declared as its ‘<samp>target</samp>’. But there is the inherent danger that an actor

26146

passing the door accidentially hits the neighboring key stone, causing the key

26147

to be pulled out again and the door to be closed immediately. Of couse this

26148

would shatter any <a href="#ac_005fmarble">ac_marble</a> or <a href="#ac_005fpearl">ac_pearl</a>. But a ‘<samp>secure</samp>’ key

26149

stone checks that the hitting actor is not positioned on one of the key stones

26150

target positions. It refuses any actions caused by such critical hits. Note

26151

that in case the target is a callback function that closes the adjacent door,

26152

there will be still no protection. A key stone with ‘<samp>secure</samp>’ value

26153

‘<samp>false</samp>’ would accept any hits and shatter marbles as it has been standard

26154

on older Enigma releases and is still in modes besides Enigma.

26155

26156

Usually the ‘<samp>code</samp>’ of the key stone is not visually unveiled. But if you

26157

set ‘<samp>invisible</samp>’ to the value ‘<samp>false</samp>’ the code becomes visible for

26158

number code values ‘<samp>1</samp>’ to ‘<samp>8</samp>’. This helps the user to distinguish

26159

the stones and to assign the correct <a href="#it_005fkey">it_key</a> when multiple instances are

26160

present.

26161

26162

An ‘<samp>invisible</samp>’ key stone reveals its code when a matching, unveiled

26163

<a href="#it_005fkey">it_key</a> gets inserted.

26164

26165

26166

<dt> Attributes:</dt>

26167

<dd>

26168

26169

<dt> state,   values: <code>ON</code>, <code>OFF</code>;   default: <code>OFF</code>;   See section <a href="#state">state</a></dt>

26170

<dd>Current activity state of the key stone.

26171

</dd>

26172

<dt> code,   values: number or string;   default: <code>1</code>:</dt>

26173

<dd>The code that is required to activate this switch.

26174

</dd>

26175

<dt> secure   values: <code>true</code>, <code>false</code>;   default: <code>true</code></dt>

26176

<dd>Protect actors on target positions by neglecting their hits.

26177

</dd>

26178

<dt> invisible   values: <code>true</code>, <code>false</code>;   default: <code>true</code></dt>

26179

<dd>A visible key stone unveils its ‘<samp>code</samp>’ by a color spot.

26180

</dd>

26181

</dl>

26182

26183

</dd>

26184

<dt> Messages:</dt>

26185

<dd>

26186

26187

<dt> signal   See section <a href="#signal">signal</a></dt>

26188

<dd>Switches on at value ‘<samp>1</samp>’, and off at values ‘<samp>0</samp>’.

26189

</dd>

26190

<dt> on   See section <a href="#on">on</a></dt>

26191

<dt> off   See section <a href="#off">off</a></dt>

26192

</dl>

26193

26194

</dd>

26195

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

26196

<dt> Variants:</dt>

26197

26198

<dt> <img src="images/st_key_off.png" alt="images/st_key_off"> st_key with state=<code>OFF</code>

26199

</dt>

26200

<dt> <img src="images/st_key_on.png" alt="images/st_key_on"> st_key with state=<code>ON</code>

26201

</dt>

26202

</dl>

26203

</dd>

26204

</dl>

26205

26206

26207

26208

26209

26210

26211

26212

26213

26214

26215

26216

26217

26218

26219

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

26220

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

26221

26222

</tr></table>

26223

26224

<h3 class="subsection">9.5.31 st_knight</h3>

26225

26226

26227

A sword bearing knight stone that shatters all marbles that hit it, as long as

26228

they are not protected by an activated <a href="#it_005fumbrella">it_umbrella</a> or wield an

26229

<a href="#it_005fsword">it_sword</a>.

26230

26231

By hitting ‘<samp>st_knight</samp>’ with an <a href="#it_005fsword">it_sword</a> four times, the knight stone

26232

spits out a cheeky remark and can be passed thereafter, even without a sword.

26233

26234

A beaten knight stone is transparent to laser light.

26235

26236

26237

<dt> Attributes:</dt>

26238

<dd>

26239

26240

<dt> state,   values: <code>0</code> to <code>4</code>;   default: <code>0</code>; access: <code>read only</code>   See section <a href="#state">state</a></dt>

26241

<dd>Current hit count of the knight stone. Starting uninjured at state ‘<samp>0</samp>’

26242

the knight is beaten after 4 hits.

26243

</dd>

26244

</dl>

26245

26246

</dd>

26247

<dt> Messages: none</dt>

26248

<dt> Action: none</dt>

26249

<dt> Variants:</dt>

26250

26251

<dt> <img src="images/st_knight.png" alt="images/st_knight"> st_knight

26252

</dt>

26253

</dl>

26254

26255

</dd>

26256

</dl>

26257

26258

26259

26260

26261

26262

26263

26264

26265

26266

26267

26268

26269

26270

26271

26272

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

26273

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

26274

26275

</tr></table>

26276

26277

<h3 class="subsection">9.5.32 st_laser</h3>

26278

26279

26280

The laser stone is the only object that is capable of emitting light beams.

26281

Per default laser stones are switched off. The ‘<samp>state</samp>’ attribute represents

26282

the activity of the laser and can be set initially to ‘<samp>ON</samp>’. A laser is

26283

orientated to one direction into which the light will be emitted.

26284

26285

Lasers have a latency that protect them from infinite fast switching cycles. This

26286

allows you to toggle a laser with an <a href="#st_005flaserswitch">st_laserswitch</a> that is illuminated

26287

by the laser itself. During the latency period pending switch requests will be

26288

registered but will be executed with a certain small delay. Note that several

26289

pending requests may even neutralize are revoke each other.

26290

26291

An initially switched on laser will not cause actions with its light beam due

26292

to the <a href="#Snapshot-Principle">Snapshot Principle</a>. If you have need of the actions you may switch

26293

on the laser by a message in the ‘<samp>postinit</samp>’ function

26294

(See section <a href="#Level-Initialization">Level Initialization</a>). E.g. a flickering laser caused by a laser that

26295

illuminates a <a href="#st_005flaserswitch">st_laserswitch</a> which toggles the laser needs to be switched

26296

on by a message.

26297

26298

26299

<dt> Attributes:</dt>

26300

<dd>

26301

26302

<dt> state,   values: <code>ON</code>, <code>OFF</code>;   default: <code>OFF</code>   See section <a href="#state">state</a></dt>

26303

<dt> orientation,   values: <code>NORTH</code>, <code>EAST</code>, <code>SOUTH</code>, <code>WEST</code>;   default: <code>NORTH</code></dt>

26304

<dd>The orientation of the laser. It determines the direction that the laser will

26305

emit light if it is switched on.

26306

</dd>

26307

<dt> counterclock   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

26308

<dd>The standard turning direction is clockwise. Use this attribute to revert the

26309

direction.

26310

</dd>

26311

</dl>

26312

26313

</dd>

26314

<dt> Messages:</dt>

26315

<dd>

26316

26317

<dt> signal   See section <a href="#signal">signal</a></dt>

26318

<dd>Switch the laser on at value ‘<samp>1</samp>’ and off at value ‘<samp>0</samp>’.

26319

</dd>

26320

<dt> on   See section <a href="#on">on</a></dt>

26321

<dt> off   See section <a href="#off">off</a></dt>

26322

26323

<dd>Turn orientation in turning direction as defined by attribute

26324

‘<samp>counterclock</samp>’.

26325

</dd>

26326

<dt> turnback</dt>

26327

<dd>Turn orientation in opposite turning direction as defined by attribute

26328

‘<samp>counterclock</samp>’.

26329

</dd>

26330

</dl>

26331

26332

</dd>

26333

<dt> Action: none</dt>

26334

<dt> Variants:</dt>

26335

26336

<tr><td width="8%"><img src="images/st_laser_d.png" alt="images/st_laser_d"></td><td width="42%">st_laser_w: orientation = <code>WEST</code>, state = <code>OFF</code></td><td width="8%"><img src="images/st_laser_d6.png" alt="images/st_laser_d6"></td><td width="42%">st_laser_w: orientation = <code>WEST</code>, state = <code>ON</code></td></tr>

26337

<tr><td width="8%"><img src="images/st_laser_c.png" alt="images/st_laser_c"></td><td width="42%">st_laser_s: orientation = <code>SOUTH</code>, state = <code>OFF</code></td><td width="8%"><img src="images/st_laser_c6.png" alt="images/st_laser_c6"></td><td width="42%">st_laser_s: orientation = <code>SOUTH</code>, state = <code>ON</code></td></tr>

26338

<tr><td width="8%"><img src="images/st_laser_b.png" alt="images/st_laser_b"></td><td width="42%">st_laser_e: orientation = <code>EAST</code>, state = <code>OFF</code></td><td width="8%"><img src="images/st_laser_b6.png" alt="images/st_laser_b6"></td><td width="42%">st_laser_e: orientation = <code>EAST</code>, state = <code>ON</code></td></tr>

26339

<tr><td width="8%"><img src="images/st_laser.png" alt="images/st_laser"></td><td width="42%">st_laser_n: orientation = <code>NORTH</code>, state = <code>OFF</code></td><td width="8%"><img src="images/st_laser_6.png" alt="images/st_laser_6"></td><td width="42%">st_laser_n: orientation = <code>NORTH</code>, state = <code>ON</code></td></tr>

26340

</table>

26341

</dd>

26342

</dl>

26343

26344

26345

26346

26347

26348

26349

26350

26351

26352

26353

26354

26355

26356

26357

26358

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

26359

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

26360

26361

</tr></table>

26362

26363

<h3 class="subsection">9.5.33 st_laserflop</h3>

26364

26365

26366

A switch that is triggered by actor hits and laser light. It switches instantly

26367

to state ‘<samp>ON</samp>’ and when it is no longer illuminated it switches back to

26368

state ‘<samp>OFF</samp>’ after a given ‘<samp>interval</samp>’. Repetitive actor hits and

26369

continuing laser light will prolong the ‘<samp>ON</samp>’ state until a trailing

26370

‘<samp>interval</samp>’ after the last hit has been expired. A similar object without

26371

light sensitiveness is the <a href="#st_005fmonoflop">st_monoflop</a>.

26372

26373

The single state cycle, called monoflop, can be initiated by ‘<samp>on</samp>’ and

26374

‘<samp>signal</samp>’ messages. But an activated monoflop cannot be stopped by

26375

messages or state setting.

26376

26377

At initialization a laserflop that is exposed to laser light will start in state

26378

‘<samp>ON</samp>’ without sending actions due to the <a href="#Snapshot-Principle">Snapshot Principle</a>.

26379

26380

A laserflop that is moved or swapped in or out of a laser beam will act on

26381

the light change with proper actions.

26382

26383

26384

<dt> Attributes:</dt>

26385

<dd>

26386

26387

<dt> state,   values: <code>ON</code>, <code>OFF</code>;   default: <code>OFF</code>;   See section <a href="#state">state</a></dt>

26388

<dd>Represents the activity state. The state of a new object can be set, but an

26389

active laserflop cannot be set to state ‘<samp>OFF</samp>’.

26390

</dd>

26391

<dt> interval   values: positive number;   default: <code>1.8</code></dt>

26392

<dd>Number of seconds to return to state ‘<samp>OFF</samp>’ after the last hit.

26393

26394

</dd>

26395

</dl>

26396

26397

</dd>

26398

<dt> Messages:</dt>

26399

<dd>

26400

26401

<dt> signal   See section <a href="#signal">signal</a></dt>

26402

<dd>Switches on at value ‘<samp>1</samp>’. A value of ‘<samp>0</samp>’ is ignored.

26403

</dd>

26404

<dt> on   See section <a href="#on">on</a></dt>

26405

<dd>Switches the laserflop on like on an actor hit.

26406

</dd>

26407

</dl>

26408

26409

</dd>

26410

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

26411

<dt> Variants:</dt>

26412

26413

<dt> <img src="images/st_monoflop.png" alt="images/st_monoflop"> st_laserflop: state = <code>OFF</code>

26414

</dt>

26415

<dt> <img src="images/st_monoflop_2.png" alt="images/st_monoflop_2"> st_laserflop: state = <code>ON</code>

26416

</dt>

26417

</dl>

26418

26419

</dd>

26420

</dl>

26421

26422

26423

26424

26425

26426

26427

26428

26429

26430

26431

26432

26433

26434

26435

26436

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

26437

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

26438

26439

</tr></table>

26440

26441

<h3 class="subsection">9.5.34 st_laserswitch</h3>

26442

26443

26444

A switch that is exclusively triggered by laser light. It switches instantly to

26445

state ‘<samp>ON</samp>’ when a laser beam hits the stone from any direction. It switches

26446

instantly back to state ‘<samp>OFF</samp>’ when it is no longer illuminated.

26447

26448

There is no way to set the state of this stone manually. But the state

26449

can nevertheless be read. At initialization a laserswitch that is exposed to

26450

laser light will start in state ‘<samp>ON</samp>’ without sending actions due to the

26451

<a href="#Snapshot-Principle">Snapshot Principle</a>.

26452

26453

A laserswitch that is moved or swapped in or out of a laser beam will act on

26454

the light change with proper actions.

26455

26456

26457

<dt> Attributes:</dt>

26458

<dd>

26459

26460

<dt> state,   values: <code>ON</code>, <code>OFF</code>;   default: <code>OFF</code>; access: <code>read only</code>   See section <a href="#state">state</a></dt>

26461

</dl>

26462

26463

</dd>

26464

<dt> Messages: none</dt>

26465

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

26466

<dd>

26467

26468

<dt> <img src="images/st_oxydb.png" alt="images/st_oxydb"> st_laserswitch: state = <code>OFF</code>

26469

</dt>

26470

<dt> <img src="images/st_quake_3.png" alt="images/st_quake_3"> st_laserswitch: state = <code>ON</code>

26471

</dt>

26472

</dl>

26473

</dd>

26474

</dl>

26475

26476

26477

26478

26479

26480

26481

26482

26483

26484

26485

26486

26487

26488

26489

26490

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

26491

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

26492

26493

</tr></table>

26494

26495

<h3 class="subsection">9.5.35 st_lightglass</h3>

26496

26497

26498

A metal framed transparent glass stone. It exists in static, movable and

26499

hollow variants and is by its very nature transparent to laser light. Like other

26500

<a href="#Transparent-Stones">Transparent Stones</a> it is passable for invisible actors as long as it is

26501

not ‘<samp>movable</samp>’.

26502

26503

A <a href="#st_005fmagic">st_magic</a> of variant <code>st_magic_oxyda</code> transforms on actor hits to

26504

a movable lightglass stone

26505

26506

26507

<dt> Attributes:</dt>

26508

<dd>

26509

26510

<dt> hollow   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: read only   See section <a href="#hollow">hollow</a></dt>

26511

<dt> movable   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: read only   See section <a href="#movable">movable</a></dt>

26512

</dl>

26513

26514

</dd>

26515

<dt> Messages: none</dt>

26516

<dt> Variants:</dt>

26517

<dd>

26518

26519

<dt> <img src="images/st_lightglass.png" alt="images/st_lightglass"> st_lightglass: hollow = <code>false</code>, movable = <code>false</code>

26520

</dt>

26521

<dt> <img src="images/st_lightglass.png" alt="images/st_lightglass"> st_lightglass_hollow: hollow = <code>true</code>, movable = <code>false</code>

26522

</dt>

26523

<dt> <img src="images/st_lightglass.png" alt="images/st_lightglass"> st_lightglass_movable: hollow = <code>false</code>, movable = <code>true</code>

26524

</dt>

26525

</dl>

26526

26527

</dd>

26528

</dl>

26529

26530

26531

26532

26533

26534

26535

26536

26537

26538

26539

26540

26541

26542

26543

26544

26545

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

26546

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

26547

26548

</tr></table>

26549

26550

<h3 class="subsection">9.5.36 st_lightpassenger</h3>

26551

26552

26553

The light passenger skates on a laser beam, and may push up to one

26554

movable stone in front of it. Opposing laser beams are ignored.

26555

When another laser beam crosses the actual laser beam on which the

26556

passenger skates, the passenger switches beams. If it is initially

26557

lighted by two rectangular beams, one of them will be chosen by

26558

random. The light passenger’s skating ability can be turned off

26559

and on.

26560

26561

When a stone is in its way, the passenger sends an impulse to the

26562

blocking stone, which may move it, but it may also have other effects;

26563

e.g., a turnstile turns around and an impulse-stone starts pulsing,

26564

but it does not open oxyds (this is intended).

26565

26566

The light passenger can’t be pushed by actors, but, e.g., by

26567

<a href="#st_005fstoneimpulse">st_stoneimpulse</a>.

26568

26569

The speed of the light passenger can be changed with the

26570

‘<samp>interval</samp>’-attribute (default 50 ms, which is quite fast) and may

26571

include the floor friction and local gradient via

26572

‘<samp>friction</samp>’ and ‘<samp>gradient</samp>’. The resulting interval results as

26573

26574

<table><tr><td> </td><td><pre class="example">interval = base * (1 + stone_friction * floor_friction) / (1 + stone_gradient * floor_gradient)

26575

</pre></td></tr></table>

26576

26577

with ‘<samp>base</samp>’ the value of the ‘<samp>interval</samp>’-attribute,

26578

‘<samp>floor_friction</samp>’ the friction of the floor below the light passenger,

26579

and ‘<samp>floor_gradient</samp>’ the parallel part of the force of the floor,

26580

i.e., the sum of gradient-force and <code>force_x/y</code>-attributes.

26581

26582

The light passenger can be switched on and off by messages (see below), and

26583

appears as ‘<samp>st_darkglass</samp>’ when inactive. A player with an <a href="#it_005fglasses">it_glasses</a>

26584

in his inventory that includes the ‘<samp>SPOT_LIGHTPASSENGER</samp>’ feature is able

26585

to distinguish the switched off lightpassenger from an ‘<samp>st_darkglass</samp>’.

26586

The variant ‘<samp>st_lightpassenger_off</samp>’ is deactivated from the beginning.

26587

A lightpassenger that moves onto an <a href="#it_005fcross">it_cross</a> switches off immediately. A

26588

switched off lightpassenger can be switched on by an actor hit with a revealed

26589

<a href="#it_005fbrush">it_brush</a> in the inventory. Such a touch with a brush does wipe out a

26590

cross beneath the lightpassenger, too.

26591

26592

An <a href="#st_005fboulder">st_boulder</a> hitting a lightpassenger toggles the lightpassenger’s state

26593

for a short period.

26594

26595

When an active ‘<samp>st_lightpassenger</samp>’ is trapped between exactly two

26596

opposing light beams or light beams from all four directions, it

26597

starts blinking. In this state, it can be destroyed with

26598

<a href="#it_005fhammer">it_hammer</a>.

26599

26600

26601

<dt> Attributes:</dt>

26602

<dd>

26603

26604

<dt> state,   values: <code>ON</code>, <code>OFF</code>;   default: <code>ON</code>;   See section <a href="#state">state</a></dt>

26605

<dd>Represents the activity state.

26606

</dd>

26607

<dt> interval   values: positive number;   default: <code>0.05</code></dt>

26608

<dd>The base interval for movements.

26609

</dd>

26610

<dt> friction   values: positive number;   default: <code>0.0</code></dt>

26611

<dd>Stone friction of the speed of the light passenger.

26612

</dd>

26613

<dt> gradient   values: positive number;   default: <code>0.0</code></dt>

26614

<dd>Stone gradient of the speed of the light passenger.

26615

26616

</dd>

26617

</dl>

26618

26619

</dd>

26620

<dt> Messages:</dt>

26621

<dd>

26622

26623

<dt> signal   See section <a href="#signal">signal</a></dt>

26624

<dd>Switches on at value ‘<samp>1</samp>’. A values of ‘<samp>0</samp>’ is ignored.

26625

</dd>

26626

<dt> on   See section <a href="#on">on</a></dt>

26627

<dd>Switch the lightpassenger on.

26628

</dd>

26629

<dt> off   See section <a href="#off">off</a></dt>

26630

<dd>Switch the lightpassenger off.

26631

</dd>

26632

</dl>

26633

26634

</dd>

26635

<dt> Variants:</dt>

26636

<dd>

26637

26638

<dt> <img src="images/st_lightpassenger.png" alt="images/st_lightpassenger"> st_lightpassenger: state = <code>ON</code>

26639

</dt>

26640

<dt> <img src="images/st_lightpassenger.png" alt="images/st_lightpassenger"> st_lightpassenger_on: state = <code>ON</code>

26641

</dt>

26642

<dt> <img src="images/st_darkglass.png" alt="images/st_darkglass"> st_lightpassenger_off: state = <code>OFF</code>

26643

</dt>

26644

</dl>

26645

26646

</dd>

26647

</dl>

26648

26649

26650

26651

26652

26653

26654

26655

26656

26657

26658

26659

26660

26661

26662

26663

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

26664

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

26665

26666

</tr></table>

26667

26668

<h3 class="subsection">9.5.37 st_magic</h3>

26669

26670

26671

A stone that mimics one stone, but transforms on actor hits into another stone.

26672

26673

Like <a href="#st_005ffake">st_fake</a> this stone does initially look like another stone of a kind

26674

given by the attribute ‘<samp>flavor</samp>’. But on an actor hit with or without tool

26675

it transforms to another stone, which provides its own set of features.

26676

26677

The flavor <code>"brick"</code> just transforms on a hit with a revealed

26678

<a href="#it_005fmagicwand">it_magicwand</a> into a static <a href="#st_005frawglass">st_rawglass</a>.

26679

26680

The flavor <code>"oxyda"</code> transforms on any hit into a movable

26681

<a href="#st_005flightglass">st_lightglass</a>.

26682

26683

The flavor <code>"oxydc"</code> transforms on any hit into a movable

26684

<a href="#st_005frawglass">st_rawglass</a>.

26685

26686

26687

<dt> Attributes:</dt>

26688

<dd>

26689

26690

<dt> flavor   values: <code>"brick"</code>, <code>"oxyda"</code>, <code>"oxydc"</code>;   default: <code>"brick"</code>;   access: read only</dt>

26691

</dl>

26692

26693

</dd>

26694

<dt> Messages: none</dt>

26695

<dt> Action: none</dt>

26696

<dt> Variants:</dt>

26697

<dd>

26698

26699

<dt> <img src="images/st_brick.png" alt="images/st_brick"> st_magic: flavor=<code>"brick"</code>

26700

</dt>

26701

<dt> <img src="images/st_brick.png" alt="images/st_brick"> st_magic_brick: flavor=<code>"brick"</code>

26702

</dt>

26703

<dt> <img src="images/st_oxyda.png" alt="images/st_oxyda"> st_magic_oxyda: flavor=<code>"oxyda"</code>

26704

</dt>

26705

<dt> <img src="images/st_oxydc.png" alt="images/st_oxydc"> st_magic_oxydc: flavor=<code>"oxydc"</code>

26706

</dt>

26707

</dl>

26708

26709

</dd>

26710

</dl>

26711

26712

26713

26714

26715

26716

26717

26718

26719

26720

26721

26722

26723

26724

26725

26726

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

26727

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

26728

26729

</tr></table>

26730

26731

26732

26733

26734

When hit by an actor, a mail stone takes the first item out of the player’s

26735

inventory and drops it at its exit, or the exit of the appending <a href="#it_005fpipe">it_pipe</a>.

26736

If this position is blocked (e.g., by another item), no item is taken from

26737

inventory. The <a href="#it_005fbrake">it_brake</a> is the only item that gets delivered even if

26738

another item is positioned at the end of the pipe as it emerges the pipe as an

26739

<a href="#st_005fbrake">st_brake</a> stone. An <a href="#it_005fpipe">it_pipe</a> end piece with just one fitting connection

26740

closes a mail pipe completely, rejecting any item insertion.

26741

26742

26743

<dt> Attributes:</dt>

26744

<dd>

26745

26746

<dt> orientation,   values: <code>NORTH</code>, <code>EAST</code>, <code>SOUTH</code>, <code>WEST</code>;   default: <code>NORTH</code></dt>

26747

<dd>The orientation of the mail stone. It determines the neighbors grid position

26748

onto which the item will be dropped, or where the pipe starts.

26749

</dd>

26750

</dl>

26751

26752

</dd>

26753

<dt> Messages: none</dt>

26754

<dt> Action: none</dt>

26755

<dt> Variants:</dt>

26756

<dd>

26757

26758

<dt> <img src="images/st_mail.png" alt="images/st_mail"> st_mail: orientation = <code>NORTH</code>

26759

</dt>

26760

<dt> <img src="images/st_mail_3.png" alt="images/st_mail_3"> st_mail_w: orientation = <code>WEST</code>

26761

</dt>

26762

<dt> <img src="images/st_mail_4.png" alt="images/st_mail_4"> st_mail_s: orientation = <code>SOUTH</code>

26763

</dt>

26764

<dt> <img src="images/st_mail_2.png" alt="images/st_mail_2"> st_mail_e: orientation = <code>EAST</code>

26765

</dt>

26766

<dt> <img src="images/st_mail.png" alt="images/st_mail"> st_mail_n: orientation = <code>NORTH</code>

26767

</dt>

26768

</dl>

26769

26770

</dd>

26771

</dl>

26772

26773

26774

26775

26776

26777

26778

26779

26780

26781

26782

26783

26784

26785

26786

26787

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

26788

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

26789

26790

</tr></table>

26791

26792

<h3 class="subsection">9.5.39 st_mirror</h3>

26793

26794

26795

Mirror stones redirect and fork laser beams. They exist in different shapes.

26796

You can set the shape by the attribute ‘<samp>flavor</samp>’ or by using the

26797

appropriate subkind. There are two planar versions called ‘<samp>slab</samp>’ and

26798

‘<samp>sheets</samp>’, and a ‘<samp>triangle</samp>’ version.

26799

26800

The mirror panes can either be non-transparent or semi-transparent. Even though

26801

you set this feature with the attribute ‘<samp>transparent</samp>’ you should be aware

26802

that even with a value of ‘<samp>true</samp>’ the mirror is not fully transparent. E.g.

26803

a ‘<samp>slab</samp>’ mirror will block any laser light that is parallel to its shape

26804

as the short ends are no mirrors at all. For this reason we provide the second

26805

planar version called ‘<samp>sheets</samp>’, which lets light parallel to its sheets

26806

pass.

26807

26808

Mirrors hit by an actor or impulsed by an <a href="#st_005fstoneimpulse">st_stoneimpulse</a> will move if

26809

their attribute ‘<samp>movable</samp>’ is set to true. Mirrors that are not movable

26810

will differ slightly in a darker color.

26811

26812

Mirrors hit or just touched will turn their mirror panes by 90 degrees. The

26813

standard turning direction is clockwise. But this standard can be changed

26814

by the attribute ‘<samp>counterclock</samp>’. An <a href="#st_005fboulder">st_boulder</a> hitting a mirror

26815

will turn it in its standard direction, too.

26816

26817

A mirror can be turned into the opposite direction either by a message

26818

‘<samp>turnback</samp>’ or by an actor with a revealed <a href="#it_005fwrench">it_wrench</a> in its

26819

inventory.

26820

26821

Mirrors moved by stone pushing impulses issued by <a href="#it_005fpuller">it_puller</a>,

26822

<a href="#st_005fstoneimpulse">st_stoneimpulse</a>,... or send by <a href="#ot_005fwire">ot_wire</a> will move without being turned.

26823

26824

26825

<dt> Attributes:</dt>

26826

<dd>

26827

26828

<dt> flavor   values: <code>"slab"</code>, <code>"sheets"</code>, <code>"triangle"</code>;   default: <code>"slab"</code></dt>

26829

<dd>Mirror panes either set up as a triangle or as a side opaque slab or

26830

as a mandatory semi-transparent pair of sheets.

26831

</dd>

26832

<dt> state,   values: <code>NORTH</code>, <code>EAST</code>, <code>SOUTH</code>, <code>WEST</code>;   default: <code>NORTH</code>;   See section <a href="#state">state</a></dt>

26833

<dd>The orientation of the mirror. For a triangular mirror it is the triangle’s

26834

pointing direction. For a planar mirror it is the reflection direction of an

26835

incoming northbound beam.

26836

</dd>

26837

<dt> orientation,   values: <code>NORTH</code>, <code>EAST</code>, <code>SOUTH</code>, <code>WEST</code>, <code>RANDOMDIR</code>;   default: <code>NORTH</code></dt>

26838

<dd>The orientation of the mirror. For a triangular mirror it is the triangle’s

26839

pointing direction. For a planar mirror it is the reflection direction of an

26840

incoming northbound beam. The value <code>RANDOMDIR</code> is just evaluated when the

26841

mirror is being set. From this point of time the mirror will report a random

26842

orientation out of the other 4 real orientations.

26843

</dd>

26844

<dt> transparent   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

26845

<dd>Semitransparency of the mirror panes.

26846

</dd>

26847

<dt> movable   values: <code>true</code>, <code>false</code>;   default: <code>false</code>   See section <a href="#movable">movable</a></dt>

26848

<dd>Movability on actor hits and stone impulses.

26849

</dd>

26850

<dt> counterclock   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

26851

<dd>The standard turning direction is clockwise. Use this attribute to revert the

26852

direction.

26853

</dd>

26854

</dl>

26855

26856

</dd>

26857

<dt> Messages:</dt>

26858

<dd>

26859

26860

26861

</dd>

26862

<dt> orientate,   value type: orientation</dt>

26863

<dd>Change the orientation to the given orientation value. The <a href="#st_005ffourswitch">st_fourswitch</a>

26864

provides a compatible action which allows you to set a mirror as

26865

target and this message as action.

26866

</dd>

26867

26868

<dd>Turn the orientation in turning direction as defined by attribute

26869

‘<samp>counterclock</samp>’.

26870

</dd>

26871

<dt> turnback</dt>

26872

<dd>Turn the orientation in opposite turning direction as defined by attribute

26873

‘<samp>counterclock</samp>’.

26874

</dd>

26875

<dt> signal   See section <a href="#signal">signal</a></dt>

26876

<dd>Turn the orientation in turning direction as defined by attribute

26877

‘<samp>counterclock</samp>’ on value ‘<samp>1</samp>’. A value of ‘<samp>0</samp>’ is ignored.

26878

26879

</dd>

26880

</dl>

26881

26882

</dd>

26883

<dt> Action: none</dt>

26884

<dt> Variants:</dt>

26885

26886

<tr><td width="8%"><img src="images/st_mirror_static.png" alt="images/st_mirror_static"></td><td width="42%">st_mirror_triangle: flavor=<code>triangle</code>, state = <code>NORTH</code>, transparent = <code>false</code>, movable = <code>false</code></td><td width="8%"><img src="images/st_mirror_movable.png" alt="images/st_mirror_movable"></td><td width="42%">st_mirror_triangle: flavor=<code>triangle</code>, state = <code>NORTH</code>, transparent = <code>false</code>, movable = <code>true</code></td></tr>

26887

<tr><td width="8%"><img src="images/st_mirror_static_2.png" alt="images/st_mirror_static_2"></td><td width="42%">st_mirror_triangle: flavor=<code>triangle</code>, state = <code>EAST</code>, transparent = <code>false</code>, movable = <code>false</code></td><td width="8%"><img src="images/st_mirror_movable_2.png" alt="images/st_mirror_movable_2"></td><td width="42%">st_mirror_triangle: flavor=<code>triangle</code>, state = <code>EAST</code>, transparent = <code>false</code>, movable = <code>true</code></td></tr>

26888

<tr><td width="8%"><img src="images/st_mirror_static_3.png" alt="images/st_mirror_static_3"></td><td width="42%">st_mirror_triangle: flavor=<code>triangle</code>, state = <code>SOUTH</code>, transparent = <code>false</code>, movable = <code>false</code></td><td width="8%"><img src="images/st_mirror_movable_3.png" alt="images/st_mirror_movable_3"></td><td width="42%">st_mirror_triangle: flavor=<code>triangle</code>, state = <code>SOUTH</code>, transparent = <code>false</code>, movable = <code>true</code></td></tr>

26889

<tr><td width="8%"><img src="images/st_mirror_static_4.png" alt="images/st_mirror_static_4"></td><td width="42%">st_mirror_triangle: flavor=<code>triangle</code>, state = <code>WEST</code>, transparent = <code>false</code>, movable = <code>false</code></td><td width="8%"><img src="images/st_mirror_movable_4.png" alt="images/st_mirror_movable_4"></td><td width="42%">st_mirror_triangle: flavor=<code>triangle</code>, state = <code>WEST</code>, transparent = <code>false</code>, movable = <code>true</code></td></tr>

26890

<tr><td width="8%"><img src="images/st_mirror_static_b.png" alt="images/st_mirror_static_b"></td><td width="42%">st_mirror_triangle: flavor=<code>triangle</code>, state = <code>NORTH</code>, transparent = <code>true</code>, movable = <code>false</code></td><td width="8%"><img src="images/st_mirror_movable_b.png" alt="images/st_mirror_movable_b"></td><td width="42%">st_mirror_triangle: flavor=<code>triangle</code>, state = <code>NORTH</code>, transparent = <code>true</code>, movable = <code>true</code></td></tr>

26891

<tr><td width="8%"><img src="images/st_mirror_static_b2.png" alt="images/st_mirror_static_b2"></td><td width="42%">st_mirror_triangle: flavor=<code>triangle</code>, state = <code>EAST</code>, transparent = <code>true</code>, movable = <code>false</code></td><td width="8%"><img src="images/st_mirror_movable_b2.png" alt="images/st_mirror_movable_b2"></td><td width="42%">st_mirror_triangle: flavor=<code>triangle</code>, state = <code>EAST</code>, transparent = <code>true</code>, movable = <code>true</code></td></tr>

26892

<tr><td width="8%"><img src="images/st_mirror_static_b3.png" alt="images/st_mirror_static_b3"></td><td width="42%">st_mirror_triangle: flavor=<code>triangle</code>, state = <code>SOUTH</code>, transparent = <code>true</code>, movable = <code>false</code></td><td width="8%"><img src="images/st_mirror_movable_b3.png" alt="images/st_mirror_movable_b3"></td><td width="42%">st_mirror_triangle: flavor=<code>triangle</code>, state = <code>SOUTH</code>, transparent = <code>true</code>, movable = <code>true</code></td></tr>

26893

<tr><td width="8%"><img src="images/st_mirror_static_b4.png" alt="images/st_mirror_static_b4"></td><td width="42%">st_mirror_triangle: flavor=<code>triangle</code>, state = <code>WEST</code>, transparent = <code>true</code>, movable = <code>false</code></td><td width="8%"><img src="images/st_mirror_movable_b4.png" alt="images/st_mirror_movable_b4"></td><td width="42%">st_mirror_triangle: flavor=<code>triangle</code>, state = <code>WEST</code>, transparent = <code>true</code>, movable = <code>true</code></td></tr>

26894

<tr><td width="8%"><img src="images/st_mirror_static_c.png" alt="images/st_mirror_static_c"></td><td width="42%">st_mirror_slab: flavor=<code>slab</code>, state = <code>NORTH</code>, transparent = <code>false</code>, movable = <code>false</code></td><td width="8%"><img src="images/st_mirror_movable_c.png" alt="images/st_mirror_movable_c"></td><td width="42%">st_mirror_slab: flavor=<code>slab</code>, state = <code>NORTH</code>, transparent = <code>false</code>, movable = <code>true</code></td></tr>

26895

<tr><td width="8%"><img src="images/st_mirror_static_c2.png" alt="images/st_mirror_static_c2"></td><td width="42%">st_mirror_slab: flavor=<code>slab</code>, state = <code>EAST</code>, transparent = <code>false</code>, movable = <code>false</code></td><td width="8%"><img src="images/st_mirror_movable_c2.png" alt="images/st_mirror_movable_c2"></td><td width="42%">st_mirror_slab: flavor=<code>slab</code>, state = <code>EAST</code>, transparent = <code>false</code>, movable = <code>true</code></td></tr>

26896

<tr><td width="8%"><img src="images/st_mirror_static_c3.png" alt="images/st_mirror_static_c3"></td><td width="42%">st_mirror_slab: flavor=<code>slab</code>, state = <code>SOUTH</code>, transparent = <code>false</code>, movable = <code>false</code></td><td width="8%"><img src="images/st_mirror_movable_c3.png" alt="images/st_mirror_movable_c3"></td><td width="42%">st_mirror_slab: flavor=<code>slab</code>, state = <code>SOUTH</code>, transparent = <code>false</code>, movable = <code>true</code></td></tr>

26897

<tr><td width="8%"><img src="images/st_mirror_static_c4.png" alt="images/st_mirror_static_c4"></td><td width="42%">st_mirror_slab: flavor=<code>slab</code>, state = <code>WEST</code>, transparent = <code>false</code>, movable = <code>false</code></td><td width="8%"><img src="images/st_mirror_movable_c4.png" alt="images/st_mirror_movable_c4"></td><td width="42%">st_mirror_slab: flavor=<code>slab</code>, state = <code>WEST</code>, transparent = <code>false</code>, movable = <code>true</code></td></tr>

26898

<tr><td width="8%"><img src="images/st_mirror_static_d.png" alt="images/st_mirror_static_d"></td><td width="42%">st_mirror_slab: flavor=<code>slab</code>, state = <code>NORTH</code>, transparent = <code>true</code>, movable = <code>false</code></td><td width="8%"><img src="images/st_mirror_movable_d.png" alt="images/st_mirror_movable_d"></td><td width="42%">st_mirror_slab: flavor=<code>slab</code>, state = <code>NORTH</code>, transparent = <code>true</code>, movable = <code>true</code></td></tr>

26899

<tr><td width="8%"><img src="images/st_mirror_static_d2.png" alt="images/st_mirror_static_d2"></td><td width="42%">st_mirror_slab: flavor=<code>slab</code>, state = <code>EAST</code>, transparent = <code>true</code>, movable = <code>false</code></td><td width="8%"><img src="images/st_mirror_movable_d2.png" alt="images/st_mirror_movable_d2"></td><td width="42%">st_mirror_slab: flavor=<code>slab</code>, state = <code>EAST</code>, transparent = <code>true</code>, movable = <code>true</code></td></tr>

26900

<tr><td width="8%"><img src="images/st_mirror_static_d3.png" alt="images/st_mirror_static_d3"></td><td width="42%">st_mirror_slab: flavor=<code>slab</code>, state = <code>SOUTH</code>, transparent = <code>true</code>, movable = <code>false</code></td><td width="8%"><img src="images/st_mirror_movable_d3.png" alt="images/st_mirror_movable_d3"></td><td width="42%">st_mirror_slab: flavor=<code>slab</code>, state = <code>SOUTH</code>, transparent = <code>true</code>, movable = <code>true</code></td></tr>

26901

<tr><td width="8%"><img src="images/st_mirror_static_d4.png" alt="images/st_mirror_static_d4"></td><td width="42%">st_mirror_slab: flavor=<code>slab</code>, state = <code>WEST</code>, transparent = <code>true</code>, movable = <code>false</code></td><td width="8%"><img src="images/st_mirror_movable_d4.png" alt="images/st_mirror_movable_d4"></td><td width="42%">st_mirror_slab: flavor=<code>slab</code>, state = <code>WEST</code>, transparent = <code>true</code>, movable = <code>true</code></td></tr>

26902

<tr><td width="8%"><img src="images/st_mirror_static_e.png" alt="images/st_mirror_static_e"></td><td width="42%">st_mirror_sheets: flavor=<code>sheets</code>, state = <code>NORTH</code>, transparent = <code>true</code>, movable = <code>false</code></td><td width="8%"><img src="images/st_mirror_movable_e.png" alt="images/st_mirror_movable_e"></td><td width="42%">st_mirror_sheets: flavor=<code>sheets</code>, state = <code>NORTH</code>, transparent = <code>true</code>, movable = <code>true</code></td></tr>

26903

<tr><td width="8%"><img src="images/st_mirror_static_e2.png" alt="images/st_mirror_static_e2"></td><td width="42%">st_mirror_sheets: flavor=<code>sheets</code>, state = <code>EAST</code>, transparent = <code>true</code>, movable = <code>false</code></td><td width="8%"><img src="images/st_mirror_movable_e2.png" alt="images/st_mirror_movable_e2"></td><td width="42%">st_mirror_sheets: flavor=<code>sheets</code>, state = <code>EAST</code>, transparent = <code>true</code>, movable = <code>true</code></td></tr>

26904

<tr><td width="8%"><img src="images/st_mirror_static_e3.png" alt="images/st_mirror_static_e3"></td><td width="42%">st_mirror_sheets: flavor=<code>sheets</code>, state = <code>SOUTH</code>, transparent = <code>true</code>, movable = <code>false</code></td><td width="8%"><img src="images/st_mirror_movable_e3.png" alt="images/st_mirror_movable_e3"></td><td width="42%">st_mirror_sheets: flavor=<code>sheets</code>, state = <code>SOUTH</code>, transparent = <code>true</code>, movable = <code>true</code></td></tr>

26905

<tr><td width="8%"><img src="images/st_mirror_static_e4.png" alt="images/st_mirror_static_e4"></td><td width="42%">st_mirror_sheets: flavor=<code>sheets</code>, state = <code>WEST</code>, transparent = <code>true</code>, movable = <code>false</code></td><td width="8%"><img src="images/st_mirror_movable_e4.png" alt="images/st_mirror_movable_e4"></td><td width="42%">st_mirror_sheets: flavor=<code>sheets</code>, state = <code>WEST</code>, transparent = <code>true</code>, movable = <code>true</code></td></tr>

26906

</table>

26907

26908

</dd>

26909

</dl>

26910

26911

26912

26913

26914

26915

26916

26917

26918

26919

26920

26921

26922

26923

26924

26925

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

26926

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

26927

26928

</tr></table>

26929

26930

<h3 class="subsection">9.5.40 st_monoflop</h3>

26931

26932

26933

A switch that is triggered by actor hits. It switches instantly to

26934

state ‘<samp>ON</samp>’ and after a given ‘<samp>interval</samp>’ back to state ‘<samp>OFF</samp>’.

26935

Repetitive actor hits will prolong the ‘<samp>ON</samp>’ state until a trailing

26936

‘<samp>interval</samp>’ after the last hit has been expired. A switch similar to

26937

the monoflop is the <a href="#st_005flaserflop">st_laserflop</a>, which is additionally light sensitive.

26938

26939

The single state cycle, called monoflop, can be initiated by ‘<samp>on</samp>’ and

26940

‘<samp>signal</samp>’ messages. But an activated monoflop cannot be stopped by

26941

messages or state setting.

26942

26943

26944

<dt> Attributes:</dt>

26945

<dd>

26946

26947

<dt> state,   values: <code>ON</code>, <code>OFF</code>;   default: <code>OFF</code>;   See section <a href="#state">state</a></dt>

26948

<dd>Represents the activity state. The state of a new object can be set, but an

26949

active monoflop cannot be set to state ‘<samp>OFF</samp>’.

26950

</dd>

26951

<dt> interval   values: positive number;   default: <code>1.8</code></dt>

26952

<dd>Number of seconds to return to state ‘<samp>OFF</samp>’ after the last hit.

26953

26954

</dd>

26955

</dl>

26956

26957

</dd>

26958

<dt> Messages:</dt>

26959

<dd>

26960

26961

<dt> signal   See section <a href="#signal">signal</a></dt>

26962

<dd>Switches on at value ‘<samp>1</samp>’. A values of ‘<samp>0</samp>’ is ignored.

26963

</dd>

26964

<dt> on   See section <a href="#on">on</a></dt>

26965

<dd>Switch the monoflop on like on an actor hit.

26966

</dd>

26967

</dl>

26968

26969

</dd>

26970

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

26971

<dt> Variants:</dt>

26972

26973

<dt> <img src="images/st_monoflop.png" alt="images/st_monoflop"> st_monoflop: state = <code>OFF</code>

26974

</dt>

26975

<dt> <img src="images/st_monoflop_2.png" alt="images/st_monoflop_2"> st_monoflop: state = <code>ON</code>

26976

</dt>

26977

</dl>

26978

</dd>

26979

</dl>

26980

26981

26982

26983

26984

26985

26986

26987

26988

26989

26990

26991

26992

26993

26994

26995

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

26996

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

26997

26998

</tr></table>

26999

27000

<h3 class="subsection">9.5.41 st_oneway</h3>

27001

27002

27003

A stone with one special face, that allows actors just to pass from inside

27004

to outside but not vice versa. The other faces can generally be passed in both

27005

directions. As most times it is more important to be aware of the passages that

27006

are blocked, you may remember that the oneway’s arrow points to the side that

27007

can not be entered.

27008

27009

Three variants of the oneway do exist. A neutral, green-grey colored one that

27010

lets any actor pass according to the above rules, and additionally a black and

27011

a white colored oneway. These last oneways will let pass only marbles of

27012

matching color. All other actors will reflect from all four sides.

27013

27014

All oneways can only be passed by actors moving on the floor. Jumping actors

27015

will bounce on every side.

27016

27017

The ‘<samp>orientation</samp>’ of a neutral oneway can be flipped to the opposite

27018

direction by an actor hitting it with a revealed <a href="#it_005fmagicwand">it_magicwand</a>. All

27019

oneway variations will change their orientation on messages ‘<samp>signal</samp>’ and

27020

‘<samp>flip</samp>’.

27021

27022

27023

<dt> Attributes:</dt>

27024

<dd>

27025

27026

<dt> state,   values: <code>NORTH</code>, <code>EAST</code>, <code>SOUTH</code>, <code>WEST</code>;   default: <code>NORTH</code>   See section <a href="#state">state</a></dt>

27027

<dd>The orientation of the oneway as shown by the arrow.

27028

</dd>

27029

<dt> orientation,   values: <code>NORTH</code>, <code>EAST</code>, <code>SOUTH</code>, <code>WEST</code>;   default: <code>NORTH</code></dt>

27030

<dd>The orientation of the oneway as shown by the arrow.

27031

</dd>

27032

<dt> color   values: <code>nil</code>, <code>BLACK</code>, <code>WHITE</code>;   default: <code>nil</code></dt>

27033

<dd>The color of the oneway that needs to match the actor’s color to allow passing.

27034

The default ‘<samp>nil</samp>’ color is a greengrey oneway that matches all actors,

27035

marbles of any color as well as all other actors.

27036

</dd>

27037

</dl>

27038

27039

</dd>

27040

<dt> Messages:</dt>

27041

<dd>

27042

27043

<dt> orientate,   value type: orientation</dt>

27044

<dd>Change the orientation to the given orientation value. The <a href="#st_005ffourswitch">st_fourswitch</a>

27045

provides a compatible action which allows you to set a oneway as

27046

target and this message as action.

27047

</dd>

27048

27049

<dd>Flip the orientation to the opposite direction.

27050

</dd>

27051

<dt> signal   See section <a href="#signal">signal</a></dt>

27052

<dd>Flip the orientation to the opposite direction.

27053

</dd>

27054

</dl>

27055

27056

</dd>

27057

<dt> Action: none</dt>

27058

<dt> Variants:</dt>

27059

27060

<tr><td width="8%"><img src="images/st_oneway.png" alt="images/st_oneway"></td><td width="42%">st_oneway: orientation = <code>EAST</code></td><td width="8%"><img src="images/st_oneway_2.png" alt="images/st_oneway_2"></td><td width="42%">st_oneway: orientation = <code>NORTH</code></td></tr>

27061

<tr><td width="8%"><img src="images/st_oneway_3.png" alt="images/st_oneway_3"></td><td width="42%">st_oneway: orientation = <code>SOUTH</code></td><td width="8%"><img src="images/st_oneway_4.png" alt="images/st_oneway_4"></td><td width="42%">st_oneway: orientation = <code>WEST</code></td></tr>

27062

<tr><td width="8%"><img src="images/st_oneway_b.png" alt="images/st_oneway_b"></td><td width="42%">st_oneway_black: color = <code>BLACK</code>; orientation = <code>EAST</code></td><td width="8%"><img src="images/st_oneway_b2.png" alt="images/st_oneway_b2"></td><td width="42%">st_oneway_black: color = <code>BLACK</code>; orientation = <code>NORTH</code></td></tr>

27063

<tr><td width="8%"><img src="images/st_oneway_b3.png" alt="images/st_oneway_b3"></td><td width="42%">st_oneway_black: color = <code>BLACK</code>; orientation = <code>SOUTH</code></td><td width="8%"><img src="images/st_oneway_b4.png" alt="images/st_oneway_b4"></td><td width="42%">st_oneway_black: color = <code>BLACK</code>; orientation = <code>WEST</code></td></tr>

27064

<tr><td width="8%"><img src="images/st_oneway_c.png" alt="images/st_oneway_c"></td><td width="42%">st_oneway_white: color = <code>WHITE</code>; orientation = <code>EAST</code></td><td width="8%"><img src="images/st_oneway_c2.png" alt="images/st_oneway_c2"></td><td width="42%">st_oneway_white: color = <code>WHITE</code>; orientation = <code>NORTH</code></td></tr>

27065

<tr><td width="8%"><img src="images/st_oneway_c3.png" alt="images/st_oneway_c3"></td><td width="42%">st_oneway_white: color = <code>WHITE</code>; orientation = <code>SOUTH</code></td><td width="8%"><img src="images/st_oneway_c4.png" alt="images/st_oneway_c4"></td><td width="42%">st_oneway_white: color = <code>WHITE</code>; orientation = <code>WEST</code></td></tr>

27066

</table>

27067

</dd>

27068

</dl>

27069

27070

27071

27072

27073

27074

27075

27076

27077

27078

27079

27080

27081

27082

27083

27084

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

27085

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

27086

27087

</tr></table>

27088

27089

27090

27091

27092

The main target stones of the game. Opening all regular oxyd stones is the

27093

standard goal of the existing <a href="#Ending-Conditions">Ending Conditions</a>. Regular oxyds stones show

27094

a color spot when opening. Pairs of same colored stones have to be opened in

27095

sequence, otherwise the first one closes again.

27096

27097

Even though most levels make use of just a single pair of each color, there

27098

is no limit on a single color. If you like you can define 3 pairs of blue oxyds

27099

together with 2 yellow pairs. You do this by setting explicit ‘<samp>oxydcolor</samp>’

27100

attributes to the oxyds.

27101

27102

For standard levels the ‘<samp>oxydcolor</samp>’ can be set to its default ‘<samp>OXYD_AUTO</samp>’.

27103

This causes an automatic coloring by pairs of colors in the standard color

27104

sequence.

27105

27106

There is no limit on the number of used oxyd pairs. There exist 12 different

27107

regular colors for oxyds. But per default just the first 8 colors will be

27108

assigned to ‘<samp>OXYD_AUTO</samp>’ colored oxyds. The colors will repeat from the

27109

9th pair giving the user the possibility to build arbitrary couples within a

27110

single color. With the world attribute <a href="#MaxOxydColor">MaxOxydColor</a> you can lower or

27111

increase this limit. By setting this attribute to ‘<samp>OXYD_GREEN</samp>’ you can

27112

enforce the engine to assign just the first three colors. Be careful in usage

27113

of more than 8 colors as levels can get incredibly difficult.

27114

27115

The number of auto colored oxyds should usually be even as a single remaining

27116

oxyd of a color keeps a level from being solvable. In case of an uneven number

27117

one oxyd stone gets colored to ‘<samp>OXYD_FAKE</samp>’ and does not participate in the

27118

stone opening procedure. But still you can set uneven number of oxyds of a given

27119

color if you do not use auto coloring but use explicit color values. Same thing

27120

happens if you delete a single oxyd during the running game. In both cases

27121

Enigma reacts with an error message by default. You can suppress this exception

27122

by setting <a href="#AllowSingleOxyds">AllowSingleOxyds</a> to <code>true</code>. In this case it is the authors

27123

responsibility to guarantee that the level can be solved.

27124

27125

Usually oxyds are shuffled by a ‘<samp>wo:shuffleOxyd()</samp>’ statement after setting

27126

of all oxyds. All ‘<samp>CLOSED</samp>’ oxyds that are not explicitly excluded by the

27127

‘<samp>noshuffle</samp>’ attribute take place in shuffling. But you can define

27128

arbitrary rules to limit and influence the shuffling process to guarantee

27129

solvability and fairness (see section <a href="#shuffleOxyd">shuffleOxyd</a>).

27130

27131

Oxyds are opened either by an actor hit, an additional laser beam, an

27132

<a href="#st_005fboulder">st_boulder</a> triggering, an <a href="#ot_005fcannonball">ot_cannonball</a> emitted from an

27133

<a href="#st_005fspitter">st_spitter</a> or a message call. A single opened oxyd is in the

27134

state ‘<samp>OPEN</samp>’. If a matching second oxyd is opened both switch to the state

27135

‘<samp>OXYDPAIR</samp>’. Note that this state can be requested, but it can not be set

27136

directly.

27137

27138

Single opened oxyds close on a not matching partner oxyd being opened and on

27139

‘<samp>close</samp>’ messages and state setting operations. But oxyds being part of

27140

an opened pair will not be closed this way.

27141

27142

All oxyds including pairs will close on the ‘<samp>closeall</samp>’ messages that is

27143

issued by <a href="#st_005fquake">st_quake</a> and oxyds colored ‘<samp>OXYD_QUAKE</samp>’ on actor hits.

27144

27145

Closed oxyds can have different looks. Their visual representation is defined

27146

by their ‘<samp>flavor</samp>’. Most flavors do hide the oxyd color in the closed state.

27147

Only flavor <code>"e"</code> starts with hidden color, but once opened returns to

27148

a closed image with a peep hole that lets the player still see the color.

27149

27150

For each flavor exists an identical looking simple stone: ‘<samp>st_fake_oxyda</samp>’,

27151

‘<samp>st_fake_oxydb</samp>’, ‘<samp>st_fake_oxydc</samp>’, ‘<samp>st_fake_oxydd</samp>’,

27152

‘<samp>st_fake_oxyde</samp>’ (see section <a href="#st_005ffake">st_fake</a>). If you like an identical looking pseudo

27153

stone that takes part in the oxyd shuffling you can use an oxyd of color

27154

‘<samp>OXYD_FAKE</samp>’.

27155

27156

During the game oxyds can be reshuffled. Just those oxyds that are still closed

27157

will take part in the new shuffle process. Oxyd shuffling rules will still be

27158

guaranteed for these partial in game reshuffles. It can be initiated either

27159

by a ‘<samp>shuffle</samp>’ message that is send to any of the oxyd objects, or by

27160

usage of an oxyd of color ‘<samp>OXYD_BOLD</samp>’. If such a special oxyd is opened,

27161

e.g. by an actor hit, it shuffles all remaining oxyds including itself.

27162

27163

At initialization an oxyd that is exposed to laser light will start in state

27164

‘<samp>CLOSED</samp>’. As it is the gaming target it is a certain exception to the

27165

<a href="#Snapshot-Principle">Snapshot Principle</a>.

27166

27167

An oxyd that is swapped in or out of a laser beam will act on the light change

27168

with proper actions.

27169

27170

Every opened oxyd causes an action call. The action call for an opened oxyd pair

27171

occurs just once when the second oxyd starts opening, whereas the bold and quake

27172

oxyd will perform the action after completion of their task and animation. Thus

27173

you are allowed to kill quake and bold oxyds within their action as long as you

27174

properly set <a href="#safeaction">safeaction</a> to <code>true</code>.

27175

27176

For a replacement of an opened pair of oxyd stones, what can be seen in the

27177

"opal" levels, the action call is not directly suitable, because the second

27178

oxyd did not yet show its matching color. Furtheron you would have to keep track

27179

of the oxyds to find the matching partner for the second oxyd. For this reason

27180

you can directly declare replacements that should be set when an oxyd pair

27181

is opened. The replacement takes place as soon as the second oxyd finishes the

27182

opening animation. Like the <a href="#st_005fsurprise">st_surprise</a> the oxyd allows you to set

27183

the ‘<samp>selection</samp>’ attribute with tokens of strings. Every string needs either

27184

to be an <a href="#Object-Kind">Object Kind</a> or a tile key prefixed by an equal sign ‘<samp>=</samp>’.

27185

27186

<table><tr><td> </td><td><pre class="example">ti["n"] = {"st_nil"}

27187

ti["g"] = {"st_granite"}

27188

ti["s"] = {"st_oxyd_e", selection={"=n", "=g"}}

27189

</pre></td></tr></table>

27190

27191

The first token defines the replacement for the oxyd stone that has been opened

27192

first, the last token defines the replacement for the matching oxyd stone that

27193

has been opened afterwards. In case of a single token both oxyd stones are being

27194

replaced by equivalent stones.

27195

27196

The tile declarations referenced by a key may even contain objects besides

27197

stone. But you should make rare and proper usage of this feature.

27198

27199

The oxyd stone is killed by any replacement stone set to the grid position.

27200

If your selection does not resolve to a stone you may need to add <code>"st_nil"</code>

27201

to the replacement tile declaration.

27202

27203

27204

<dt> Attributes:</dt>

27205

<dd>

27206

27207

<dt> state,   values: <code>CLOSED</code>, <code>OPEN</code>, <code>OXYDPAIR</code>;   default: <code>CLOSED</code>   See section <a href="#state">state</a></dt>

27208

<dt> flavor,   values: <code>"a"</code>, <code>"b"</code>, <code>"c"</code>, <code>"d"</code>, <code>"e"</code>;   default: <code>"b"</code></dt>

27209

<dd>The flavor only affects the visual representation of the stone. Mainly the

27210

closed state and the way of opening differ in the following way:

27211

27212

<dt> <code>"a"</code> bronze, pyramid like stone that opens like a flower</dt>

27213

<dt> <code>"b"</code> black, flat stone that opens by a fade animation</dt>

27214

<dt> <code>"c"</code> blue, flat stone that opens by a concentric animation</dt>

27215

<dt> <code>"d"</code> dark blue, pyramid like stone that opens like a flower</dt>

27216

<dt> <code>"e"</code> black, flat stone that provides a peep hole after closing</dt>

27217

</dl>

27218

</dd>

27219

<dt> oxydcolor,   values: <code>OXYD_AUTO</code>, <code>OXYD_FAKE</code>, <code>OXYD_QUAKE</code>, <code>OXYD_BOLD</code>, <code>OXYD_BLUE</code>, <code>OXYD_RED</code>, <code>OXYD_GREEN</code>, <code>OXYD_YELLOW</code>, <code>OXYD_CYAN</code>, <code>OXYD_PURPLE</code>, <code>OXYD_WHITE</code>, <code>OXYD_BLACK</code>, <code>OXYD_GRAY</code>, <code>OXYD_ORANGE</code>, <code>OXYD_PINE</code>, <code>OXYD_BROWN</code>;   default: <code>OXYD_AUTO</code></dt>

27220

27221

<tr><td width="8%"><img src="images/st_oxyd_colordots.png" alt="images/st_oxyd_colordots"></td><td width="17%"><code>OXYD_BLUE</code></td><td width="8%"><img src="images/st_oxyd_colordots_2.png" alt="images/st_oxyd_colordots_2"></td><td width="17%"><code>OXYD_RED</code></td><td width="8%"><img src="images/st_oxyd_colordots_3.png" alt="images/st_oxyd_colordots_3"></td><td width="17%"><code>OXYD_GREEN</code></td><td width="8%"><img src="images/st_oxyd_colordots_4.png" alt="images/st_oxyd_colordots_4"></td><td width="17%"><code>OXYD_YELLOW</code></td></tr>

27222

<tr><td width="8%"><img src="images/st_oxyd_colordots_b.png" alt="images/st_oxyd_colordots_b"></td><td width="17%"><code>OXYD_CYAN</code></td><td width="8%"><img src="images/st_oxyd_colordots_b2.png" alt="images/st_oxyd_colordots_b2"></td><td width="17%"><code>OXYD_PURPLE</code></td><td width="8%"><img src="images/st_oxyd_colordots_b3.png" alt="images/st_oxyd_colordots_b3"></td><td width="17%"><code>OXYD_WHITE</code></td><td width="8%"><img src="images/st_oxyd_colordots_b4.png" alt="images/st_oxyd_colordots_b4"></td><td width="17%"><code>OXYD_BLACK</code></td></tr>

27223

<tr><td width="8%"><img src="images/st_oxyd_colordots_c.png" alt="images/st_oxyd_colordots_c"></td><td width="17%"><code>OXYD_GRAY</code></td><td width="8%"><img src="images/st_oxyd_colordots_c2.png" alt="images/st_oxyd_colordots_c2"></td><td width="17%"><code>OXYD_ORANGE</code></td><td width="8%"><img src="images/st_oxyd_colordots_c3.png" alt="images/st_oxyd_colordots_c3"></td><td width="17%"><code>OXYD_PINE</code></td><td width="8%"><img src="images/st_oxyd_colordots_c4.png" alt="images/st_oxyd_colordots_c4"></td><td width="17%"><code>OXYD_BROWN</code></td></tr>

27224

<tr><td width="8%"><img src="images/st_oxyd_colordots_d3.png" alt="images/st_oxyd_colordots_d3"></td><td width="17%"><code>OXYD_BOLD</code></td><td width="8%"><img src="images/st_oxyd_colordots_d4.png" alt="images/st_oxyd_colordots_d4"></td><td width="17%"><code>OXYD_QUAKE</code></td></tr>

27225

</table>

27226

</dd>

27227

<dt> noshuffle   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

27228

<dt> static   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

27229

<dd>Static oxyds are neither swappable nor pullable.

27230

</dd>

27231

<dt> selection,   values: tokens of stone kinds and tile keys;   default: no replacement</dt>

27232

</dl>

27233

27234

</dd>

27235

<dt> Messages:</dt>

27236

<dd>

27237

27238

<dt> signal   See section <a href="#signal">signal</a></dt>

27239

<dd>Try open at value ‘<samp>1</samp>’, and close at values ‘<samp>0</samp>’.

27240

</dd>

27241

<dt> open   See section <a href="#open">open</a></dt>

27242

<dt> close   See section <a href="#close">close</a></dt>

27243

<dt> closeall</dt>

27244

<dd>Closes all opened oxyds if send to any object instance.

27245

</dd>

27246

<dt> peepall</dt>

27247

<dd>All closed oxyds of flavor <code>"e"</code> will show a peep hole if this message is

27248

sent to any oxyd object instance.

27249

</dd>

27250

<dt> shuffle</dt>

27251

<dd>Reshuffles all closed oxyds if send to any object instance.

27252

</dd>

27253

</dl>

27254

27255

</dd>

27256

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

27257

<dd>Whenever a <code>CLOSED</code> oxyd gets opened an action with value <code>true</code> is

27258

performed. The action is performed directly after the oxyds own reaction on being

27259

opened, like checking gaming ending conditions, reshuffling or closing all oxyds,

27260

did finish. Additionally an action with value <code>false</code> is performed after

27261

an oxyd changes from an open state to <code>CLOSED</code>. Note that no action is

27262

performed on state changes form <code>OPEN</code> to <code>OXYDPAIR</code>.

27263

27264

</dd>

27265

<dt> Variants:</dt>

27266

<dd>

27267

27268

<dt> <img src="images/st_oxydb.png" alt="images/st_oxydb"> st_oxyd: flavor = <code>"b"</code>

27269

</dt>

27270

<dt> <img src="images/st_oxyda.png" alt="images/st_oxyda"> st_oxyd_a: flavor = <code>"a"</code>

27271

</dt>

27272

<dt> <img src="images/st_oxydb.png" alt="images/st_oxydb"> st_oxyd_b: flavor = <code>"b"</code>

27273

</dt>

27274

<dt> <img src="images/st_oxydc.png" alt="images/st_oxydc"> st_oxyd_c: flavor = <code>"c"</code>

27275

</dt>

27276

<dt> <img src="images/st_oxydd.png" alt="images/st_oxydd"> st_oxyd_d: flavor = <code>"d"</code>

27277

</dt>

27278

<dt> <img src="images/st_oxyde.png" alt="images/st_oxyde"> st_oxyd_e: flavor = <code>"e"</code>

27279

</dt>

27280

</dl>

27281

27282

</dd>

27283

</dl>

27284

27285

27286

27287

27288

27289

27290

27291

27292

27293

27294

27295

27296

27297

27298

27299

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

27300

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

27301

27302

</tr></table>

27303

27304

<h3 class="subsection">9.5.43 st_passage</h3>

27305

27306

27307

A black or white colored stone of different shapes that lets pass only actors of

27308

matching color.

27309

27310

The shape is described by the attribute ‘<samp>flavor</samp>’. The shape does not

27311

affect the behaviour, but may be important for the visibility of actors and

27312

items beneath.

27313

27314

Passage stones react on ‘<samp>signal</samp>’ and ‘<samp>toggle</samp>’ messages and

27315

<a href="#st_005fboulder">st_boulder</a> arriving on one of its sides. In both cases the passage stone

27316

recolors to the opposite color. In case of a boulder the recoloring is of a

27317

quite short period, as this stone recolors the passage twice. The period in

27318

between is long enough for an actor to pass or to redirect the boulder before

27319

sending the second recoloring message.

27320

27321

27322

<dt> Attributes:</dt>

27323

<dd>

27324

27325

<dt> color   values: <code>BLACK</code>, <code>WHITE</code>;   default: <code>BLACK</code></dt>

27326

<dd>The color of the passage that determines which actors can pass.

27327

</dd>

27328

<dt> state,   values: <code>BLACK</code>, <code>WHITE</code>;   default: <code>BLACK</code>   See section <a href="#state">state</a></dt>

27329

<dd>The state is a synonym for color.

27330

</dd>

27331

<dt> flavor   values: <code>"square"</code>, <code>"slash"</code>, <code>"cross"</code>, <code>"frame"</code>;   default: <code>"square"</code></dt>

27332

<dd>The passage shape.

27333

</dd>

27334

</dl>

27335

27336

</dd>

27337

<dt> Messages:</dt>

27338

27339

<dt> signal   See section <a href="#signal">signal</a></dt>

27340

<dd>Switch color of the passage.

27341

</dd>

27342

</dl>

27343

27344

</dd>

27345

<dt> Action: none</dt>

27346

<dt> Variants:</dt>

27347

<dd>

27348

27349

<dt> <img src="images/st_passage_black_square.png" alt="images/st_passage_black_square"> st_passage: color = <code>BLACK</code>, flavor = <code>"square"</code>

27350

</dt>

27351

<dt> <img src="images/st_passage_black_square.png" alt="images/st_passage_black_square"> st_passage_black: color = <code>BLACK</code>, flavor = <code>"square"</code>

27352

</dt>

27353

<dt> <img src="images/st_passage_black_slash.png" alt="images/st_passage_black_slash"> st_passage_black: color = <code>BLACK</code>, flavor = <code>"slash"</code>

27354

</dt>

27355

<dt> <img src="images/st_passage_black_cross.png" alt="images/st_passage_black_cross"> st_passage_black: color = <code>BLACK</code> - flavor = <code>"cross"</code>

27356

</dt>

27357

<dt> <img src="images/st_passage_black_frame.png" alt="images/st_passage_black_frame"> st_passage_black: color = <code>BLACK</code> - flavor = <code>"frame"</code>

27358

</dt>

27359

<dt> <img src="images/st_passage_white_square.png" alt="images/st_passage_white_square"> st_passage_white: color = <code>WHITE</code>, flavor = <code>"square"</code>

27360

</dt>

27361

<dt> <img src="images/st_passage_white_slash.png" alt="images/st_passage_white_slash"> st_passage_white: color = <code>WHITE</code> - flavor = <code>"slash"</code>

27362

</dt>

27363

<dt> <img src="images/st_passage_white_cross.png" alt="images/st_passage_white_cross"> st_passage_white: color = <code>WHITE</code> - flavor = <code>"cross"</code>

27364

</dt>

27365

<dt> <img src="images/st_passage_white_frame.png" alt="images/st_passage_white_frame"> st_passage_white: color = <code>WHITE</code> - flavor = <code>"frame"</code>

27366

</dt>

27367

</dl>

27368

27369

</dd>

27370

</dl>

27371

27372

27373

27374

27375

27376

27377

27378

27379

27380

27381

27382

27383

27384

27385

27386

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

27387

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

27388

27389

</tr></table>

27390

27391

<h3 class="subsection">9.5.44 st_plaster</h3>

27392

27393

27394

A sculptured gypsum stone that exists in various variations of basic stone

27395

attributes.

27396

27397

Unlike the similar looking <a href="#st_005fflat">st_flat</a> has no special features and behaves

27398

like a standard stone.

27399

27400

But it provides breakable variants. Like <a href="#st_005fbreak">st_break</a> it is breakable by

27401

laser light, neighboring ignitions like those caused by an exploding

27402

<a href="#it_005fdynamite">it_dynamite</a> on a direct neighboring position or an exploding black

27403

<a href="#it_005fbomb">it_bomb</a> on a diagonal neighboring position. It breaks on actor hits with

27404

a revealed <a href="#it_005fhammer">it_hammer</a>, too. But unlike <a href="#st_005fbreak">st_break</a> it offers a

27405

variant that is breakable and movable at the same time. Of course a possible

27406

break supersedes a possible push condition.

27407

27408

27409

<dt> Attributes:</dt>

27410

<dd>

27411

27412

<dt> hollow   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: read only   See section <a href="#hollow">hollow</a></dt>

27413

<dt> movable   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: read only   See section <a href="#movable">movable</a></dt>

27414

<dt> breakable   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: read only   See section <a href="#breakable">breakable</a></dt>

27415

</dl>

27416

27417

</dd>

27418

<dt> Messages: none</dt>

27419

<dt> Action: none</dt>

27420

<dt> Variants:</dt>

27421

<dd>

27422

27423

<dt> <img src="images/st_plaster.png" alt="images/st_plaster"> st_plaster:

27424

</dt>

27425

<dt> <img src="images/st_plaster.png" alt="images/st_plaster"> st_plaster_hollow: hollow=<code>true</code>

27426

</dt>

27427

<dt> <img src="images/st_plaster.png" alt="images/st_plaster"> st_plaster_movable: movable=<code>"true"</code>

27428

</dt>

27429

<dt> <img src="images/st_plaster.png" alt="images/st_plaster"> st_plaster_breakable: breakable=<code>"true"</code>

27430

</dt>

27431

<dt> <img src="images/st_plaster.png" alt="images/st_plaster"> st_plaster_movebreakable: movable=<code>"true"</code>, breakable=<code>"true"</code>

27432

</dt>

27433

</dl>

27434

27435

</dd>

27436

</dl>

27437

27438

27439

27440

27441

27442

27443

27444

27445

27446

27447

27448

27449

27450

27451

27452

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

27453

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

27454

27455

</tr></table>

27456

27457

27458

27459

27460

A movable stone that ceases to exist with a plop.

27461

27462

This stone behaves like any other standard movable stone. But unlike other

27463

stones it can cease under some conditions. And if it ceases it does it with

27464

a plop and some sparkles.

27465

27466

Currently there is just one flavor called <code>"slate"</code> according to its

27467

dark blue grey color. It falls and ceases to exist if pushed on <a href="#fl_005fwater">fl_water</a>,

27468

<a href="#fl_005fabyss">fl_abyss</a> or <a href="#fl_005fswamp">fl_swamp</a>. Unlike <a href="#st_005fbox">st_box</a> it does not build a floor.

27469

27470

27471

<dt> Variants:</dt>

27472

27473

<dt> <img src="images/st_plop_slate.png" alt="images/st_plop_slate"> st_plop

27474

</dt>

27475

<dt> <img src="images/st_plop_slate.png" alt="images/st_plop_slate"> st_plop_slate

27476

</dt>

27477

</dl>

27478

</dd>

27479

</dl>

27480

27481

27482

27483

27484

27485

27486

27487

27488

27489

27490

27491

27492

27493

27494

27495

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

27496

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

27497

27498

</tr></table>

27499

27500

<h3 class="subsection">9.5.46 st_polarswitch</h3>

27501

27502

27503

A special on/off switch that toggles its state on actors hitting the stone.

27504

Of course other objects can send messages on actions to make this switch turning.

27505

27506

The main purpose of this switch is its ability to switch crossing laser beams.

27507

While the switch is not transparent in its default off state, it switches to

27508

a transparent on state.

27509

27510

The switch looks like an <a href="#st_005fdarkglass">st_darkglass</a> in its opaque off state and like

27511

an <a href="#st_005flightglass">st_lightglass</a> in its transparent on state. Like other

27512

<a href="#Transparent-Stones">Transparent Stones</a> it is passable for invisible actors.

27513

27514

27515

<dt> Attributes:</dt>

27516

<dd>

27517

27518

<dt> state,   values: <code>ON</code>, <code>OFF</code>;   default: <code>OFF</code>   See section <a href="#state">state</a></dt>

27519

<dd>An ‘<samp>OFF</samp>’ state is not transparent, an ‘<samp>ON</samp>’ state is transparent.

27520

</dd>

27521

</dl>

27522

27523

</dd>

27524

<dt> Messages:</dt>

27525

<dd>

27526

27527

<dt> signal   See section <a href="#signal">signal</a></dt>

27528

<dd>Switches on at value ‘<samp>1</samp>’, and off at values ‘<samp>0</samp>’.

27529

</dd>

27530

<dt> on   See section <a href="#on">on</a></dt>

27531

<dt> off   See section <a href="#off">off</a></dt>

27532

</dl>

27533

27534

</dd>

27535

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

27536

<dt> Variants:</dt>

27537

27538

<dt> <img src="images/st_darkglass.png" alt="images/st_darkglass"> st_polarswitch: state = <code>OFF</code>

27539

</dt>

27540

<dt> <img src="images/st_lightglass.png" alt="images/st_lightglass"> st_polarswitch: state = <code>ON</code>

27541

</dt>

27542

</dl>

27543

</dd>

27544

</dl>

27545

27546

27547

27548

27549

27550

27551

27552

27553

27554

27555

27556

27557

27558

27559

27560

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

27561

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

27562

27563

</tr></table>

27564

27565

<h3 class="subsection">9.5.47 st_portal</h3>

27566

27567

27568

A gate that is just passable for some special kind of actors. Like

27569

<a href="#st_005fgrate">st_grate</a> it uses metallic frames but it does not let pass actors of all

27570

kinds.

27571

27572

The portal stone lets just pass actors of the kind given by its attribute

27573

‘<samp>flavor</samp>’.

27574

27575

The flavor <code>"horse"</code> lets just pass an <a href="#ac_005fhorse">ac_horse</a>.

27576

27577

The flavor <code>"pearl"</code> lets just pass an <a href="#ac_005fpearl">ac_pearl</a>.

27578

27579

27580

27581

<dt> Attributes:</dt>

27582

<dd>

27583

27584

<dt> flavor   values: <code>"horse"</code>, <code>"pearl"</code>;   default: <code>"horse"</code>;   access: read only</dt>

27585

</dl>

27586

27587

</dd>

27588

<dt> Messages: none</dt>

27589

<dt> Action: none</dt>

27590

<dt> Variants:</dt>

27591

27592

<dt> <img src="images/st_portal_horse.png" alt="images/st_portal_horse"> st_portal: flavor=<code>"horse"</code>

27593

</dt>

27594

<dt> <img src="images/st_portal_horse.png" alt="images/st_portal_horse"> st_portal_horse: flavor=<code>"horse"</code>

27595

</dt>

27596

<dt> <img src="images/st_portal_horse.png" alt="images/st_portal_horse"> st_portal_pearl: flavor=<code>"pearl"</code>

27597

</dt>

27598

</dl>

27599

27600

</dd>

27601

</dl>

27602

27603

27604

27605

27606

27607

27608

27609

27610

27611

27612

27613

27614

27615

27616

27617

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

27618

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

27619

27620

</tr></table>

27621

27622

27623

27624

27625

A pull stone changes its position on an initiating impulse into the reverse

27626

direction of the impulse. Thus it can not be pushed like other movable stones.

27627

But when an actor hits a pull stone it acts like being pulled. If another stone

27628

is located on the destination grid, both stones will exchange their positions.

27629

The exchange will also be performed when the pull stones receives a stone impulse

27630

via an <a href="#ot_005fwire">ot_wire</a> or a neighboring <a href="#st_005fstoneimpulse">st_stoneimpulse</a>. A similar stone is

27631

the <a href="#st_005fswap">st_swap</a>, that exchanges with stones in the forward direction of the

27632

initiating impulse.

27633

27634

Actors on the destination grid, including an initiating hitting actor, are

27635

pulled through it, not caged under them. The actors reappear on the old grid

27636

position of the pull stone with their old velocities.

27637

27638

The pull stone is laser light transparent like other glass like stones.

27639

27640

An existing stone exchange partner is not mandatory. But if a stone is located

27641

on the destination position of a pull stone some conditions must be met for a

27642

stone exchange. Connected <a href="#Cluster-Stones">Cluster Stones</a> building a block, <a href="#st_005foxyd">st_oxyd</a>

27643

configured as being ‘<samp>static</samp>’, and another <a href="#st_005fswap">st_swap</a> or pull stone that

27644

is currently engaged in an own stone exchange operation will refuse swapping.

27645

27646

Stone exchanges will not cause item hit transformations as caused by push moved

27647

stones. But the exchanged stones will react on the new floor, e.g. causing

27648

<a href="#st_005fbox">st_box</a> to sink into water.

27649

27650

Further on the exchange is atomic concerning <a href="#it_005ftrigger">it_trigger</a> detection and

27651

laser light transparency. If the exchanged stone is not transparent, the light

27652

will pass on every time slice just on one of the two grids. If the exchanged

27653

stone is floating and does not press <a href="#it_005ftrigger">it_trigger</a>s, the pull stone will

27654

press just one trigger, releasing the trigger of the old position before

27655

pressing the new position’s trigger like any other stone being pushed from one

27656

grid to the next.

27657

27658

27659

<dt> Attributes: none</dt>

27660

<dt> Messages: none</dt>

27661

<dt> Action: none</dt>

27662

<dt> Variants:</dt>

27663

27664

<dt> <img src="images/st_pull.png" alt="images/st_pull"> st_pull

27665

</dt>

27666

</dl>

27667

</dd>

27668

</dl>

27669

27670

27671

27672

27673

27674

27675

27676

27677

27678

27679

27680

27681

27682

27683

27684

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

27685

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

27686

27687

</tr></table>

27688

27689

<h3 class="subsection">9.5.49 st_puzzle</h3>

27690

27691

27692

Puzzle stones can construct large clusters of stones, that move together and can

27693

be destroyed together. There are two colors, blue and yellow puzzle stones,

27694

which behave different. Each of these color families again consists of 16

27695

variants that differ in the location of sockets to which neighboring puzzle

27696

stones can be attached. Further on there are hollow variants of all colors and

27697

connections.

27698

27699

A cluster is complete as soon as all sockets of all stones are connected to

27700

matching sockets of adjacent puzzle stones of the same color, but independent

27701

of being hollow or solid. A cluster fragment still has at least one stone with

27702

an open stub. A single puzzle stone with no open sockets counts as a complete

27703

cluster.

27704

27705

Puzzle stone offer manifold features. A complete cluster can explode and

27706

dissolve. Cluster fragments and complete clusters can move and will sink on some

27707

floors building bridges. Rows and columns of adjacent, identical colored puzzle

27708

stones, connected and unconnected ones, can shift rotate thus allowing the

27709

player to rearrange and sort the puzzle.

27710

27711

Blue puzzle stones can be moved as single stones, cluster fragments and

27712

complete clusters by an actor pushing or a stone impulse by <a href="#ot_005fwire">ot_wire</a> or

27713

<a href="#st_005fstoneimpulse">st_stoneimpulse</a>. Of course all new positions of the moving puzzle must be

27714

free of other stones. If all new positions are <a href="#fl_005fwater">fl_water</a> the blue puzzle

27715

will sink and leave an object of the kind given by the global attribute

27716

<a href="#FallenPuzzle">FallenPuzzle</a>. The replacement defaults to <a href="#fl_005fgray">fl_gray</a> building a bridge

27717

over the water. The user can prohibit the sinking of the puzzle into water by

27718

pushing with a revealed <a href="#it_005fmagicwand">it_magicwand</a>. If all new positions are

27719

<a href="#fl_005fabyss">fl_abyss</a> just complete blue clusters will sink and build a bridge. If all

27720

new positions are either abyss or water with at least one abyss floor just

27721

complete blue clusters will sink. Note that puzzles just sink on moves. Moving

27722

a blue fragment besides another fragment on abyss so that both fragments build

27723

a complete cluster will not sink the new cluster. It will sink as a whole on the

27724

next move. If two or more stones of a cluster receive wire impulses originating

27725

from a single event, the whole cluster will move multiple times. But it will

27726

sink on the first opportunity.

27727

27728

Just single unconnected yellow puzzle stones can be moved by actors. They will

27729

neither sink in <a href="#fl_005fwater">fl_water</a> nor fall in <a href="#fl_005fabyss">fl_abyss</a>. Any yellow cluster of

27730

two or more stones can not be moved by actor hits. But on receiving stone

27731

impulses they move like blue puzzles.

27732

27733

All puzzle stone moves do not cause standard item transformations, like

27734

<a href="#it_005fcoin">it_coin</a> value changes, <a href="#it_005fbomb">it_bomb</a> explosions, etc. But they all are not

27735

floating and thus do press <a href="#it_005ftrigger">it_trigger</a>s and close <a href="#fl_005fbridge">fl_bridge</a>s.

27736

27737

Hollow puzzle stones let pass actors, either moving on the floor or jumping,

27738

and laser light without any interaction, too.

27739

27740

Complete clusters can explode and dissolve. A precondition is that the cluster

27741

is isolated from any adjacent, same colored further puzzle stone. Such clusters

27742

explode on an additional new laser beam hitting one of its solid stones. Yellow

27743

ones explode on any actor hit. Blue ones only on actor hits with a revealed

27744

<a href="#it_005fmagicwand">it_magicwand</a>. Additionally complete clusters will explode when an

27745

<a href="#ot_005fcannonball">ot_cannonball</a> emitted by an <a href="#st_005fspitter">st_spitter</a> happens to fall on top of

27746

one of the puzzle stones of the cluster.

27747

27748

Exploding puzzles will stay in place and do not interact any more. The exploding

27749

stones are lethal for actors hitting them, but an actor can start an explosion

27750

beneath a hollow puzzle stone and stay beneath this hollow exploding stone

27751

without harm until the puzzle dissolved.

27752

27753

Puzzles can be rearranged by column and row rotations. Blue puzzle react just

27754

on actor hits with a revealed wand, yellow ones on any actor hit. All colors

27755

do rotate on laser light hits. All rotations can originate only on a solid

27756

puzzle stone. All subsequent puzzle stones of the same color will shift away

27757

with the last puzzle of the line returning to the origin. This operation is

27758

called <code>"push_rotate"</code> and can be initiated by a message, too.

27759

27760

In case of actor hits possible explosions precede moves, which precede rotation

27761

operations. Thus you need to touch a blue puzzle row carefully with a revealed

27762

wand if the row is part of a movable cluster fragment. If the speed is

27763

sufficient for a hit operation, the cluster will move instead of an expected

27764

row rotation. An actor hit on a blue puzzle that did neither cause an explosion

27765

or a rotation will be propagated by an <a href="#ot_005fwire">ot_wire</a> connected to this puzzle

27766

stone. Hits on yellow puzzle stones will never propagate to <a href="#ot_005fwire">ot_wire</a>

27767

connected other stones.

27768

27769

Like <a href="#Cluster-Stones">Cluster Stones</a> puzzles accept a ‘<samp>cluster</samp>’ attribute. A new set

27770

puzzle stone autoconnects to adjacent, same colored puzzle stones belonging to

27771

the same cluster. But once set the puzzle stone will of course not change its

27772

connections on subsequent moves or rotations. But as a level author you need to

27773

think of possible puzzle stones pushed to positions neighboring an area on which

27774

a puzzle might be set during the running game. The new set stones may

27775

autoconnect to such unexpected stones if the color and cluster number fits.

27776

27777

The resolver <a href="#res_002epuzzle">res.puzzle</a> provides easy methods to set and shuffle puzzles.

27778

The attributes ‘<samp>algorithm</samp>’ and ‘<samp>intensity</samp>’ are used by the resolver

27779

only.

27780

27781

If you need to shuffle a puzzle of your own, you can make use of the messages

27782

‘<samp>get_adjacents</samp>’ which returns the group of color matching, adjacent puzzle

27783

stones, and ‘<samp>pull_rotate</samp>’ which is the exact inversion of a push rotation.

27784

27785

27786

<dt> Attributes:</dt>

27787

<dt> color   values: <code>BLUE</code>, <code>YELLOW</code>;   default: <code>BLUE</code></dt>

27788

<dd>The color of the puzzle stubs. Adjacent puzzle stones of matching colors and

27789

connections cluster to fragments.

27790

27791

</dd>

27792

<dt> connections,   values: string;   default: <code>nil</code></dt>

27793

<dd>Describes the connection stubs of the puzzle stone. The string is a substring

27794

of <code>"nesw"</code> listing the stubs. The sequence of the sides, north, east,

27795

south, west, is guaranteed on read access but arbitrary on write access.

27796

27797

</dd>

27798

<dt> cluster   values: number;   default: <code>nil</code></dt>

27799

<dd>If set to a number all adjacent puzzle stones of the same color with

27800

the identical cluster number will build a cluster. This attribute supersedes

27801

any explicitly given connection description.

27802

27803

</dd>

27804

<dt> hollow   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

27805

<dd>A hollow puzzle stone has a hole in its middle and allows actors to pass beneath.

27806

27807

</dd>

27808

<dt> algorithm,   values: string;   default: <code>nil</code></dt>

27809

<dt> intensity   values: number;   default: <code>3</code></dt>

27810

<dt> Messages:</dt>

27811

27812

<dt> get_adjacents</dt>

27813

<dd>Returns the huddle of all adjacent puzzle stones of same color independent of

27814

being connected or not. The huddle is returned as a group.

27815

</dd>

27816

<dt> pull_rotate,   value type: orientation</dt>

27817

<dd>Perform a reverse ‘<samp>push_rotate</samp>’ from this puzzle stones with the line

27818

of puzzle stone into the given direction.

27819

</dd>

27820

<dt> push_rotate,   value type: orientation</dt>

27821

<dd>Perform a line rotation as described above from this puzzle stones with the line

27822

of puzzle stone into the given direction.

27823

27824

</dd>

27825

</dl>

27826

27827

</dd>

27828

<dt> Action: none</dt>

27829

<dt> Variants:</dt>

27830

<dd>

27831

<table>

27832

<tr><td width="8%"><img src="images/st_puzzle_blue.png" alt="images/st_puzzle_blue"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>""</code>, hollow = <code>false</code></td><td width="8%"><img src="images/st_puzzle_blue_2.png" alt="images/st_puzzle_blue_2"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"w"</code>, hollow = <code>false</code></td></tr>

27833

<tr><td width="8%"><img src="images/st_puzzle_blue_3.png" alt="images/st_puzzle_blue_3"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"s"</code>, hollow = <code>false</code></td><td width="8%"><img src="images/st_puzzle_blue_4.png" alt="images/st_puzzle_blue_4"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"sw"</code>, hollow = <code>false</code></td></tr>

27834

<tr><td width="8%"><img src="images/st_puzzle_blue_b.png" alt="images/st_puzzle_blue_b"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"e"</code>, hollow = <code>false</code></td><td width="8%"><img src="images/st_puzzle_blue_b2.png" alt="images/st_puzzle_blue_b2"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"ew"</code>, hollow = <code>false</code></td></tr>

27835

<tr><td width="8%"><img src="images/st_puzzle_blue_b3.png" alt="images/st_puzzle_blue_b3"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"es"</code>, hollow = <code>false</code></td><td width="8%"><img src="images/st_puzzle_blue_b4.png" alt="images/st_puzzle_blue_b4"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"esw"</code>, hollow = <code>false</code></td></tr>

27836

<tr><td width="8%"><img src="images/st_puzzle_blue_c.png" alt="images/st_puzzle_blue_c"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"n"</code>, hollow = <code>false</code></td><td width="8%"><img src="images/st_puzzle_blue_c2.png" alt="images/st_puzzle_blue_c2"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"nw"</code>, hollow = <code>false</code></td></tr>

27837

<tr><td width="8%"><img src="images/st_puzzle_blue_c3.png" alt="images/st_puzzle_blue_c3"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"ns"</code>, hollow = <code>false</code></td><td width="8%"><img src="images/st_puzzle_blue_c4.png" alt="images/st_puzzle_blue_c4"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"nsw"</code>, hollow = <code>false</code></td></tr>

27838

<tr><td width="8%"><img src="images/st_puzzle_blue_d.png" alt="images/st_puzzle_blue_d"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"ne"</code>, hollow = <code>false</code></td><td width="8%"><img src="images/st_puzzle_blue_d2.png" alt="images/st_puzzle_blue_d2"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"new"</code>, hollow = <code>false</code></td></tr>

27839

<tr><td width="8%"><img src="images/st_puzzle_blue_d3.png" alt="images/st_puzzle_blue_d3"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"nes"</code>, hollow = <code>false</code></td><td width="8%"><img src="images/st_puzzle_blue_d4.png" alt="images/st_puzzle_blue_d4"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"nesw"</code>, hollow = <code>false</code></td></tr>

27840

<tr><td width="8%"><img src="images/st_puzzle_blue_hollow.png" alt="images/st_puzzle_blue_hollow"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>""</code>, hollow = <code>true</code></td><td width="8%"><img src="images/st_puzzle_blue_hollow_2.png" alt="images/st_puzzle_blue_hollow_2"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"w"</code>, hollow = <code>true</code></td></tr>

27841

<tr><td width="8%"><img src="images/st_puzzle_blue_hollow_3.png" alt="images/st_puzzle_blue_hollow_3"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"s"</code>, hollow = <code>true</code></td><td width="8%"><img src="images/st_puzzle_blue_hollow_4.png" alt="images/st_puzzle_blue_hollow_4"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"sw"</code>, hollow = <code>true</code></td></tr>

27842

<tr><td width="8%"><img src="images/st_puzzle_blue_hollow_b.png" alt="images/st_puzzle_blue_hollow_b"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"e"</code>, hollow = <code>true</code></td><td width="8%"><img src="images/st_puzzle_blue_hollow_b2.png" alt="images/st_puzzle_blue_hollow_b2"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"ew"</code>, hollow = <code>true</code></td></tr>

27843

<tr><td width="8%"><img src="images/st_puzzle_blue_hollow_b3.png" alt="images/st_puzzle_blue_hollow_b3"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"es"</code>, hollow = <code>true</code></td><td width="8%"><img src="images/st_puzzle_blue_hollow_b4.png" alt="images/st_puzzle_blue_hollow_b4"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"esw"</code>, hollow = <code>true</code></td></tr>

27844

<tr><td width="8%"><img src="images/st_puzzle_blue_hollow_c.png" alt="images/st_puzzle_blue_hollow_c"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"n"</code>, hollow = <code>true</code></td><td width="8%"><img src="images/st_puzzle_blue_hollow_c2.png" alt="images/st_puzzle_blue_hollow_c2"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"nw"</code>, hollow = <code>true</code></td></tr>

27845

<tr><td width="8%"><img src="images/st_puzzle_blue_hollow_c3.png" alt="images/st_puzzle_blue_hollow_c3"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"ns"</code>, hollow = <code>true</code></td><td width="8%"><img src="images/st_puzzle_blue_hollow_c4.png" alt="images/st_puzzle_blue_hollow_c4"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"nsw"</code>, hollow = <code>true</code></td></tr>

27846

<tr><td width="8%"><img src="images/st_puzzle_blue_hollow_d.png" alt="images/st_puzzle_blue_hollow_d"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"ne"</code>, hollow = <code>true</code></td><td width="8%"><img src="images/st_puzzle_blue_hollow_d2.png" alt="images/st_puzzle_blue_hollow_d2"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"new"</code>, hollow = <code>true</code></td></tr>

27847

<tr><td width="8%"><img src="images/st_puzzle_blue_hollow_d3.png" alt="images/st_puzzle_blue_hollow_d3"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"nes"</code>, hollow = <code>true</code></td><td width="8%"><img src="images/st_puzzle_blue_hollow_d4.png" alt="images/st_puzzle_blue_hollow_d4"></td><td width="42%">st_puzzle_blue: color = <code>BLUE</code>, connections = <code>"nesw"</code>, hollow = <code>true</code></td></tr>

27848

<tr><td width="8%"><img src="images/st_puzzle_yellow.png" alt="images/st_puzzle_yellow"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>""</code>, hollow = <code>false</code></td><td width="8%"><img src="images/st_puzzle_yellow_2.png" alt="images/st_puzzle_yellow_2"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"w"</code>, hollow = <code>false</code></td></tr>

27849

<tr><td width="8%"><img src="images/st_puzzle_yellow_3.png" alt="images/st_puzzle_yellow_3"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"s"</code>, hollow = <code>false</code></td><td width="8%"><img src="images/st_puzzle_yellow_4.png" alt="images/st_puzzle_yellow_4"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"sw"</code>, hollow = <code>false</code></td></tr>

27850

<tr><td width="8%"><img src="images/st_puzzle_yellow_b.png" alt="images/st_puzzle_yellow_b"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"e"</code>, hollow = <code>false</code></td><td width="8%"><img src="images/st_puzzle_yellow_b2.png" alt="images/st_puzzle_yellow_b2"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"ew"</code>, hollow = <code>false</code></td></tr>

27851

<tr><td width="8%"><img src="images/st_puzzle_yellow_b3.png" alt="images/st_puzzle_yellow_b3"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"es"</code>, hollow = <code>false</code></td><td width="8%"><img src="images/st_puzzle_yellow_b4.png" alt="images/st_puzzle_yellow_b4"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"esw"</code>, hollow = <code>false</code></td></tr>

27852

<tr><td width="8%"><img src="images/st_puzzle_yellow_c.png" alt="images/st_puzzle_yellow_c"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"n"</code>, hollow = <code>false</code></td><td width="8%"><img src="images/st_puzzle_yellow_c2.png" alt="images/st_puzzle_yellow_c2"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"nw"</code>, hollow = <code>false</code></td></tr>

27853

<tr><td width="8%"><img src="images/st_puzzle_yellow_c3.png" alt="images/st_puzzle_yellow_c3"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"ns"</code>, hollow = <code>false</code></td><td width="8%"><img src="images/st_puzzle_yellow_c4.png" alt="images/st_puzzle_yellow_c4"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"nsw"</code>, hollow = <code>false</code></td></tr>

27854

<tr><td width="8%"><img src="images/st_puzzle_yellow_d.png" alt="images/st_puzzle_yellow_d"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"ne"</code>, hollow = <code>false</code></td><td width="8%"><img src="images/st_puzzle_yellow_d2.png" alt="images/st_puzzle_yellow_d2"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"new"</code>, hollow = <code>false</code></td></tr>

27855

<tr><td width="8%"><img src="images/st_puzzle_yellow_d3.png" alt="images/st_puzzle_yellow_d3"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"nes"</code>, hollow = <code>false</code></td><td width="8%"><img src="images/st_puzzle_yellow_d4.png" alt="images/st_puzzle_yellow_d4"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"nesw"</code>, hollow = <code>false</code></td></tr>

27856

<tr><td width="8%"><img src="images/st_puzzle_yellow_hollow.png" alt="images/st_puzzle_yellow_hollow"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>""</code>, hollow = <code>true</code></td><td width="8%"><img src="images/st_puzzle_yellow_hollow_2.png" alt="images/st_puzzle_yellow_hollow_2"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"w"</code>, hollow = <code>true</code></td></tr>

27857

<tr><td width="8%"><img src="images/st_puzzle_yellow_hollow_3.png" alt="images/st_puzzle_yellow_hollow_3"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"s"</code>, hollow = <code>true</code></td><td width="8%"><img src="images/st_puzzle_yellow_hollow_4.png" alt="images/st_puzzle_yellow_hollow_4"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"sw"</code>, hollow = <code>true</code></td></tr>

27858

<tr><td width="8%"><img src="images/st_puzzle_yellow_hollow_b.png" alt="images/st_puzzle_yellow_hollow_b"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"e"</code>, hollow = <code>true</code></td><td width="8%"><img src="images/st_puzzle_yellow_hollow_b2.png" alt="images/st_puzzle_yellow_hollow_b2"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"ew"</code>, hollow = <code>true</code></td></tr>

27859

<tr><td width="8%"><img src="images/st_puzzle_yellow_hollow_b3.png" alt="images/st_puzzle_yellow_hollow_b3"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"es"</code>, hollow = <code>true</code></td><td width="8%"><img src="images/st_puzzle_yellow_hollow_b4.png" alt="images/st_puzzle_yellow_hollow_b4"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"esw"</code>, hollow = <code>true</code></td></tr>

27860

<tr><td width="8%"><img src="images/st_puzzle_yellow_hollow_c.png" alt="images/st_puzzle_yellow_hollow_c"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"n"</code>, hollow = <code>true</code></td><td width="8%"><img src="images/st_puzzle_yellow_hollow_c2.png" alt="images/st_puzzle_yellow_hollow_c2"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"nw"</code>, hollow = <code>true</code></td></tr>

27861

<tr><td width="8%"><img src="images/st_puzzle_yellow_hollow_c3.png" alt="images/st_puzzle_yellow_hollow_c3"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"ns"</code>, hollow = <code>true</code></td><td width="8%"><img src="images/st_puzzle_yellow_hollow_c4.png" alt="images/st_puzzle_yellow_hollow_c4"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"nsw"</code>, hollow = <code>true</code></td></tr>

27862

<tr><td width="8%"><img src="images/st_puzzle_yellow_hollow_d.png" alt="images/st_puzzle_yellow_hollow_d"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"ne"</code>, hollow = <code>true</code></td><td width="8%"><img src="images/st_puzzle_yellow_hollow_d2.png" alt="images/st_puzzle_yellow_hollow_d2"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"new"</code>, hollow = <code>true</code></td></tr>

27863

<tr><td width="8%"><img src="images/st_puzzle_yellow_hollow_d3.png" alt="images/st_puzzle_yellow_hollow_d3"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"nes"</code>, hollow = <code>true</code></td><td width="8%"><img src="images/st_puzzle_yellow_hollow_d4.png" alt="images/st_puzzle_yellow_hollow_d4"></td><td width="42%">st_puzzle_yellow: color = <code>YELLOW</code>, connections = <code>"nesw"</code>, hollow = <code>true</code></td></tr>

27864

</table>

27865

27866

</dd>

27867

</dl>

27868

27869

27870

27871

27872

27873

27874

27875

27876

27877

27878

27879

27880

27881

27882

27883

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

27884

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

27885

27886

</tr></table>

27887

27888

<h3 class="subsection">9.5.50 st_quake</h3>

27889

27890

27891

This stone looks like an <a href="#st_005foxyd">st_oxyd</a> of flavor <code>"b"</code>, but it has the

27892

unpleasant habit of quaking when being activated. Unfortunately this closes all

27893

open <a href="#st_005foxyd">st_oxyd</a>s.

27894

27895

The stone gets activated on an actor hit, on <a href="#st_005fboulder">st_boulder</a>s hit and on its

27896

destruction.

27897

27898

The player can destroy this troublemaker with an actor that reveals an

27899

<a href="#it_005fhammer">it_hammer</a>, by directing a laser light onto the quake stone or by a nearby

27900

explosion or ignition.

27901

27902

Of course you can activate and destroy it by messages and state set operations,

27903

too.

27904

27905

27906

<dt> Attributes:</dt>

27907

<dd>

27908

27909

<dt> state,   values: <code>IDLE</code>, <code>ACTIVE</code>, <code>BREAKING</code>;   default: <code>IDLE</code>:   See section <a href="#state">state</a></dt>

27910

<dd>Current state of the quake stone. You can just change the state into legal

27911

follow up states. A breaking state is final.

27912

</dd>

27913

</dl>

27914

27915

</dd>

27916

<dt> Messages:</dt>

27917

<dd>

27918

27919

<dt> toggle   See section <a href="#toggle">toggle</a></dt>

27920

<dd>Toggles stone from ‘<samp>IDLE</samp>’ to ‘<samp>ACTIVE</samp>’

27921

</dd>

27922

<dt> signal   See section <a href="#signal">signal</a></dt>

27923

<dd>Toggles stone from ‘<samp>IDLE</samp>’ to ‘<samp>ACTIVE</samp>’

27924

</dd>

27925

<dt> ignite</dt>

27926

<dd>Toggles stone to ‘<samp>BREAKING</samp>’

27927

</dd>

27928

</dl>

27929

27930

</dd>

27931

<dt> Action: none</dt>

27932

<dd>

27933

27934

<dt> <img src="images/st_oxydb.png" alt="images/st_oxydb"> st_quake: state = <code>IDLE</code>

27935

</dt>

27936

<dt> <img src="images/st_quake_3.png" alt="images/st_quake_3"> st_quake: state = <code>ACTIVE</code>

27937

</dt>

27938

<dt> <img src="images/st_quake_break.png" alt="images/st_quake_break"> st_quake: state = <code>BREAKING</code>

27939

</dt>

27940

</dl>

27941

</dd>

27942

</dl>

27943

27944

27945

27946

27947

27948

27949

27950

27951

27952

27953

27954

27955

27956

27957

27958

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

27959

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

27960

27961

</tr></table>

27962

27963

<h3 class="subsection">9.5.51 st_rawglass</h3>

27964

27965

27966

A block of raw glass. It exists in static and movable variants and is by its

27967

very nature transparent to laser light. Like other <a href="#Transparent-Stones">Transparent Stones</a> it

27968

is passable for invisible actors.

27969

27970

This stone comes in a second texture variant that looks like being composed

27971

of 4 small rawglasses. This ‘<samp>quad</samp>’ variant is not movable.

27972

27973

27974

<dt> Attributes:</dt>

27975

<dd>

27976

27977

<dt> movable   values: <code>true</code>, <code>false</code>;   default: <code>false</code>;   access: read only   See section <a href="#movable">movable</a></dt>

27978

</dl>

27979

27980

</dd>

27981

<dt> Messages: none</dt>

27982

<dt> Variants:</dt>

27983

<dd>

27984

27985

<dt> <img src="images/st_rawglass.png" alt="images/st_rawglass"> st_rawglass: movable = <code>false</code>

27986

</dt>

27987

<dt> <img src="images/st_rawglass_quad.png" alt="images/st_rawglass_quad"> st_rawglass_quad: movable = <code>false</code>

27988

</dt>

27989

<dt> <img src="images/st_rawglass.png" alt="images/st_rawglass"> st_rawglass_movable: movable = <code>true</code>

27990

</dt>

27991

</dl>

27992

27993

</dd>

27994

</dl>

27995

27996

27997

27998

27999

28000

28001

28002

28003

28004

28005

28006

28007

28008

28009

28010

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

28011

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

28012

28013

</tr></table>

28014

28015

<h3 class="subsection">9.5.52 st_redfiber</h3>

28016

28017

28018

A metal frame with woven red fiber. Like other <a href="#Transparent-Stones">Transparent Stones</a> it is

28019

passable transparent to laser light. But the redfiber is not passable to any

28020

actors.

28021

28022

28023

<dt> Attributes: none</dt>

28024

<dt> Messages: none</dt>

28025

<dt> Variants:</dt>

28026

<dd>

28027

28028

<dt> <img src="images/st_redfiber.png" alt="images/st_redfiber"> st_redfiber

28029

</dt>

28030

</dl>

28031

28032

</dd>

28033

</dl>

28034

28035

28036

28037

28038

28039

28040

28041

28042

28043

28044

28045

28046

28047

28048

28049

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

28050

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

28051

28052

</tr></table>

28053

28054

<h3 class="subsection">9.5.53 st_rotator</h3>

28055

28056

28057

Rotators send impulses to neighboring stones, thus pushing them in the direction

28058

given by the rotation. <a href="#st_005fboulder">st_boulder</a> additionally change their orientation to

28059

the one they are pushed to.

28060

28061

Rotators can either rotate in clockwise or counterclockwise direction. They can

28062

be movable or unmovable.

28063

28064

The rotator changes its rotation direction when hit by an actor with a revealed

28065

<a href="#it_005fwrench">it_wrench</a> and by laser beams. Every additional laser beam causes a change

28066

in the rotation direction.

28067

28068

28069

<dt> Attributes:</dt>

28070

<dd>

28071

28072

<dt> state,   values: <code>CW</code>, <code>CCW</code>;   default: <code>CW</code>   See section <a href="#state">state</a></dt>

28073

<dd>The rotation direction - ‘<samp>CW</samp>’ for clockwise as default, or ‘<samp>CCW</samp>’ for

28074

counter clockwise.

28075

</dd>

28076

<dt> counterclock   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

28077

<dd>The standard rotation direction is clockwise. Use this attribute to revert the

28078

direction.

28079

</dd>

28080

<dt> movable   values: <code>true</code>, <code>false</code>;   default: <code>false</code>   See section <a href="#movable">movable</a></dt>

28081

</dl>

28082

28083

</dd>

28084

<dt> Messages:</dt>

28085

<dd>

28086

28087

<dt> toggle   See section <a href="#toggle">toggle</a></dt>

28088

<dd>Switches the rotation direction.

28089

</dd>

28090

</dl>

28091

28092

</dd>

28093

<dt> Variants:</dt>

28094

28095

<dt> <img src="images/st_rotator_cw.png" alt="images/st_rotator_cw"> st_rotator: state = <code>CW</code>

28096

</dt>

28097

<dt> <img src="images/st_rotator_cw.png" alt="images/st_rotator_cw"> st_rotator_cw: state = <code>CW</code>

28098

</dt>

28099

<dt> <img src="images/st_rotator_ccw.png" alt="images/st_rotator_ccw"> st_rotator_ccw: state = <code>CCW</code>

28100

</dt>

28101

</dl>

28102

</dd>

28103

</dl>

28104

28105

28106

28107

28108

28109

28110

28111

28112

28113

28114

28115

28116

28117

28118

28119

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

28120

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

28121

28122

</tr></table>

28123

28124

<h3 class="subsection">9.5.54 st_rubberband</h3>

28125

28126

28127

A rubberband stone attaches a new <a href="#ot_005frubberband">ot_rubberband</a> between actors hitting it

28128

and itself.

28129

28130

No rubberband is attached if the hitting actor is already connected to this

28131

particular stone.

28132

28133

If the attribute ‘<samp>scissor</samp>’ is ‘<samp>true</samp>’, all rubberbands connected to

28134

the hitting actor are removed prior to attaching the direct new connection.

28135

28136

The rubberband stone is static by default. But an actor with a revealed

28137

<a href="#it_005fmagicwand">it_magicwand</a> can move it by hitting it. As the actor will get connected by

28138

an <a href="#ot_005frubberband">ot_rubberband</a> at the same time you will usually place an

28139

<a href="#st_005fscissors">st_scissors</a> near the target place as an opportunity for the marble to free

28140

itself again from the rubberband stone.

28141

28142

28143

<dt> Attributes:</dt>

28144

<dd>

28145

28146

<dt> strength   values: number;   default: <code>10.0</code></dt>

28147

<dd>The force strength.

28148

</dd>

28149

<dt> length   values: positive number or <code>AUTOLENGTH</code>;   default: <code>1.0</code></dt>

28150

<dd>The natural length above which forces are applied.

28151

</dd>

28152

<dt> threshold   values: positive number or zero;   default: <code>0.0</code></dt>

28153

<dd>The length smaller than the natural length below which inverted forces are applied.

28154

</dd>

28155

<dt> min   values: positive number or zero;   default: <code>0.0</code></dt>

28156

<dd>The minimum length at which actors bounce.

28157

</dd>

28158

<dt> max   values: positive number or zero;   default: <code>0.0</code></dt>

28159

<dd>The maximum length at which actors bounce.

28160

</dd>

28161

<dt> scissor,   values: <code>true</code>, <code>false</code>;   default: <code>true</code></dt>

28162

<dd>Rubberband cutting behaviour on connection.

28163

</dd>

28164

</dl>

28165

28166

</dd>

28167

<dt> Messages: none</dt>

28168

<dt> Variants:</dt>

28169

28170

<dt> <img src="images/st_rubberband.png" alt="images/st_rubberband"> st_rubberband

28171

</dt>

28172

</dl>

28173

</dd>

28174

</dl>

28175

28176

28177

28178

28179

28180

28181

28182

28183

28184

28185

28186

28187

28188

28189

28190

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

28191

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

28192

28193

</tr></table>

28194

28195

<h3 class="subsection">9.5.55 st_scissors</h3>

28196

28197

28198

This stone cuts all <a href="#ot_005frubberband">ot_rubberband</a>s attached to an actor that touches it.

28199

When at least one rubber band is cut, it performs the action given in the

28200

action/target-pair.

28201

28202

28203

<dt> Attributes: none</dt>

28204

<dt> Messages: none</dt>

28205

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

28206

<dd>Sends an action message with value ‘<samp>true</samp>’ on freeing an actor from its

28207

rubberbands.

28208

28209

</dd>

28210

<dt> Variants:</dt>

28211

28212

<dt> <img src="images/st_scissors.png" alt="images/st_scissors"> st_scissors

28213

</dt>

28214

</dl>

28215

</dd>

28216

</dl>

28217

28218

28219

28220

28221

28222

28223

28224

28225

28226

28227

28228

28229

28230

28231

28232

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

28233

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

28234

28235

</tr></table>

28236

28237

<h3 class="subsection">9.5.56 st_shogun</h3>

28238

28239

28240

Shogun stones are nestable stones like Fukuroma or Matryoshka dolls. The

28241

different basic variations are distinguishable by their central hole. Small,

28242

medium and large ones do exist. In contrast to the Fukuroma dolls you can push

28243

smaller variations beneath the larger ones but not vice versa. You can see

28244

smaller shoguns pushed beneath larger ones through the upper, larger hole.

28245

Thus the player is always aware of the stack of shogun stones positioned on a

28246

single grid.

28247

28248

An actor or a stone impulse hitting a shogun stack will push the smallest shogun

28249

out of the stack. The upper and larger shogun stones can never be moved out of

28250

a stack and larger shoguns stones can never be pushed over smaller ones.

28251

28252

<a href="#it_005fshogun">it_shogun</a> are a special trigger type for shogun stones represented by

28253

animated blue dots. They just react on shogun stacks positioned on top of the

28254

dot items. All shogun sizes must be present from the smallest up to the size

28255

of the dot itself.

28256

28257

Shogun stones press <a href="#it_005ftrigger">it_trigger</a>, too. But all other items that react on

28258

other stones being pushed over them will not react on shogun stones. E.g.

28259

<a href="#it_005fseed">it_seed</a> will not grow, <a href="#it_005fbomb">it_bomb</a> will not explode, <a href="#it_005fcoin">it_coin</a> will

28260

not transform and <a href="#it_005fcherry">it_cherry</a> will not smash.

28261

28262

All shogun stones keep their identity even if they are pushed together onto a

28263

single grid. Thus each shogun can be connected independently to <a href="#ot_005fwire">ot_wire</a>s

28264

or <a href="#ot_005frubberband">ot_rubberband</a>s. On initialization you can set a stack of shogun onto

28265

a grid by setting a single shogun stone with a combined flavor string. The

28266

largest shogun stone of a stack will be positioned onto the grid and all smaller

28267

ones being part of the stack will be contained by the largest one. You can name

28268

the smaller shoguns of a stack by the additional attributes ‘<samp>name_m</samp>’ and

28269

‘<samp>name_s</samp>’. Every shogun, even those being part of a stack can individually

28270

be killed by sending a <a href="#kill">kill</a> message to it. By setting another stone or

28271

‘<samp>st_nil</samp>’ onto the grid currently being occupied by a shogun grid all shogun

28272

stones being part of the stack will be killed.

28273

28274

28275

<dt> Attributes:</dt>

28276

28277

<dt> flavor,   values: <code>"s"</code>, <code>"m"</code>, <code>"l"</code>, <code>"sm"</code>, <code>"sl"</code>, <code>"ml"</code>, <code>"sml"</code>;   default: <code>"s"</code>;   access: after initialization read only</dt>

28278

<dd>A string describing the hole sizes of this shogun stone and all smaller shogun

28279

stones that are positioned beneath this stone. <code>"s"</code> for a small hole, <code>"m"</code> for

28280

a medium hole, <code>"l"</code> for a large hole, plus combinations of these

28281

characters for stacks. On initialization all shoguns of this grid’s stack will

28282

be set according to this attribute, which can be prior set. After initialization

28283

this attribute is read only and reports the current stack configuration. The

28284

character sequence is guaranteed to be sorted from small to large on read access

28285

but is arbitrary on initial write access.

28286

28287

</dd>

28288

<dt> name_m   values: string;   default: <code>nil</code></dt>

28289

<dd>Name of the middle sized shogun as subpart of a stack of a large shogun.

28290

28291

</dd>

28292

<dt> name_s   values: string;   default: <code>nil</code></dt>

28293

<dd>Name of the small sized shogun as subpart of a stack of a large or middle sized

28294

shogun.

28295

28296

</dd>

28297

</dl>

28298

28299

</dd>

28300

<dt> Messages: none</dt>

28301

<dt> Action: none</dt>

28302

<dt> Variants:</dt>

28303

<dd>

28304

28305

<dt> <img src="images/st_shogun.png" alt="images/st_shogun"> st_shogun: flavor = <code>"s"</code>

28306

</dt>

28307

<dt> <img src="images/st_shogun.png" alt="images/st_shogun"> st_shogun_s: flavor = <code>"s"</code>

28308

</dt>

28309

<dt> <img src="images/st_shogun_2.png" alt="images/st_shogun_2"> st_shogun_m: flavor = <code>"m"</code>

28310

</dt>

28311

<dt> <img src="images/st_shogun_3.png" alt="images/st_shogun_3"> st_shogun_sm: flavor = <code>"sm"</code>

28312

</dt>

28313

<dt> <img src="images/st_shogun_4.png" alt="images/st_shogun_4"> st_shogun_l: flavor = <code>"l"</code>

28314

</dt>

28315

<dt> <img src="images/st_shogun_5.png" alt="images/st_shogun_5"> st_shogun_sl: flavor = <code>"sl"</code>

28316

</dt>

28317

<dt> <img src="images/st_shogun_6.png" alt="images/st_shogun_6"> st_shogun_ml: flavor = <code>"ml"</code>

28318

</dt>

28319

<dt> <img src="images/st_shogun_7.png" alt="images/st_shogun_7"> st_shogun_sml: flavor = <code>"sml"</code>

28320

</dt>

28321

</dl>

28322

28323

</dd>

28324

</dl>

28325

28326

28327

28328

28329

28330

28331

28332

28333

28334

28335

28336

28337

28338

28339

28340

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

28341

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

28342

28343

</tr></table>

28344

28345

<h3 class="subsection">9.5.57 st_spitter</h3>

28346

28347

28348

A stone that spits <a href="#ot_005fcannonball">ot_cannonball</a>s on actor hits and on proper messages.

28349

The standard spitter is ‘<samp>ACTIVE</samp>’ showing a slow rotating animation. In

28350

this ‘<samp>state</samp>’ the spitter reacts on actor hits, while being ‘<samp>IDLE</samp>’

28351

it is steady and will spit just on messages.

28352

28353

On an actor hit the spitter checks the owner’s inventory for an existing

28354

<a href="#it_005fextralife">it_extralife</a>. If one exists that is not stuffed in a <a href="#it_005fbag">it_bag</a>, it

28355

takes it and spits an <a href="#ot_005fcannonball">ot_cannonball</a> according to the actors velocity

28356

and its own hit attributes. The cannonball flies into the resulting direction

28357

with a speed that is proportional to the actors hit speed.

28358

28359

All cannonballs fly the same period of time. They fly above all other objects

28360

and cross all stone walls. The flight distance is proportional to their initial

28361

speed. On landing they cause actions on some objects and destroy others:

28362

28363

<ul>

28364

<li> <a href="#st_005foxyd">st_oxyd</a> do open,

28365

</li><li> <a href="#st_005fstoneimpulse">st_stoneimpulse</a> do pulse,

28366

</li><li> <a href="#st_005fyinyang">st_yinyang</a> do toggle,

28367

</li><li> <a href="#st_005fpuzzle">st_puzzle</a> do explode completely connected clusters,

28368

</li><li> <a href="#st_005fbrownpyramid">st_brownpyramid</a> do break,

28369

</li><li> <a href="#st_005fspitter">st_spitter</a> do break, if not being ‘<samp>secure</samp>’

28370

</li><li> other stones do remain unmodified and protect items and floors,

28371

</li><li> <a href="#it_005fdynamite">it_dynamite</a> do ignite,

28372

</li><li> <a href="#it_005fcrack">it_crack</a> do crack,

28373

</li><li> other indestructible items do remain and protect floors,

28374

</li><li> other items are blown away by an <a href="#it_005fexplosion">it_explosion</a>_debris that may destruct the floor,too,

28375

</li><li> floors dissolve via an <a href="#it_005fexplosion">it_explosion</a>_debris if not being indestructible as <a href="#fl_005fwater">fl_water</a>, <a href="#fl_005fswamp">fl_swamp</a>, <a href="#fl_005fabyss">fl_abyss</a>.

28376

</li></ul>

28377

28378

Actors will not be harmed by falling cannonballs.

28379

28380

The spitting can be initiated by the message <code>"hit"</code>, too. No

28381

<a href="#it_005fextralife">it_extralife</a> is needed in this case. The hit message takes either a

28382

destination as message value or in case no value is given it evaluates the

28383

‘<samp>destination</samp>’ attribute. The second case is suitable for usage of

28384

‘<samp>hit</samp>’ as an action message.

28385

28386

The destination can be any value that evaluates to a valid position, object

28387

references and object names included. In case of a ‘<samp>destination</samp>’

28388

attribute you can even supply tokens describing a series of destination

28389

positions. The destinations will be targeted by the cannonballs in turn on

28390

a sequence of ‘<samp>hit</samp>’ actions.

28391

28392

Note that the destruction of target objects can have unexpected side effects

28393

on the destination sequence. If you list three <a href="#st_005fstoneimpulse">st_stoneimpulse</a> as

28394

destinations they will be targeted in the given sequence as none of them

28395

gets destroyed. But if you list three <a href="#st_005fbrownpyramid">st_brownpyramid</a> the first

28396

cannonball destroys the first target, leaving two valid destinations. The

28397

spitter now targets the second target of its list, which happens to evaluate

28398

to the third brown pyramid stone. Finally the destination list has just one

28399

still existing brown pyramid, the second one, as target. This one will be

28400

destroyed on the next spit as the spitter starts again on the first (remaining)

28401

destination when the end of list is reached. This may be no problem if you

28402

want to destroy objects randomly or if you use named destinations with

28403

wildcards. But if you need control about the sequence you need either

28404

destinations targets that get not destroyed or floor object references, as

28405

they represent <a href="#Named-Positions">Named Positions</a> that are persistent to object destruction.

28406

28407

28408

<dt> Attributes:</dt>

28409

<dd>

28410

28411

<dt> state,   values: <code>IDLE</code>, <code>ACTIVE</code>;   default: <code>ACTIVE</code>   See section <a href="#state">state</a></dt>

28412

<dd>An ‘<samp>ACTIVE</samp>’ spitter is animated and reacts on actor hits while an ‘<samp>IDLE</samp>’

28413

looks steady and does not spit on actor hits.

28414

</dd>

28415

<dt> hit_strength   values: floating point numbers;   default: <code>1.0</code>;   See section <a href="#hit_005f_002a">hit_*</a></dt>

28416

<dt> hit_distortion_xx   values: floating point numbers;   default: <code>1.0</code>;   See section <a href="#hit_005f_002a">hit_*</a></dt>

28417

<dt> hit_distortion_xy   values: floating point numbers;   default: <code>0.0</code>;   See section <a href="#hit_005f_002a">hit_*</a></dt>

28418

<dt> hit_distortion_yx   values: floating point numbers;   default: <code>0.0</code>;   See section <a href="#hit_005f_002a">hit_*</a></dt>

28419

<dt> hit_distortion_yy   values: floating point numbers;   default: <code>1.0</code>;   See section <a href="#hit_005f_002a">hit_*</a></dt>

28420

<dt> destination,   values: tokens or position;   default: <code>nil</code>   See section <a href="#destination">destination</a></dt>

28421

<dd>The destination of the cannonball given by an object or a position.

28422

</dd>

28423

<dt> secure   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

28424

<dd>Unsecure spitters do break on a <a href="#ot_005fcannonball">ot_cannonball</a> hit.

28425

</dd>

28426

</dl>

28427

28428

</dd>

28429

<dt> Messages:</dt>

28430

<dd>

28431

28432

28433

<dd>Spit a cannonball. Takes either a destination as message value or ‘<samp>nil</samp>’.

28434

</dd>

28435

</dl>

28436

28437

</dd>

28438

<dt> Variants:</dt>

28439

28440

<dt> <img src="images/st_spitter_idle.png" alt="images/st_spitter_idle"> st_spitter: secure = <code>false</code>, state = <code>ACTIVE</code>

28441

</dt>

28442

</dl>

28443

28444

</dd>

28445

</dl>

28446

28447

28448

28449

28450

28451

28452

28453

28454

28455

28456

28457

28458

28459

28460

28461

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

28462

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

28463

28464

</tr></table>

28465

28466

<h3 class="subsection">9.5.58 st_stoneimpulse</h3>

28467

28468

28469

When being triggered these stones do pulse and send stone pushing impulses to

28470

their direct neighbors. There exist solid, hollow and movable variants of this

28471

stone.

28472

28473

The pulsing can either be triggered by an actor touching or hitting the stone,

28474

by receiving a stone impulse from a neighboring <a href="#st_005fstoneimpulse">st_stoneimpulse</a>, via

28475

<a href="#ot_005fwire">ot_wire</a> or a dropped <a href="#it_005fpuller">it_puller</a>. Further on laser light, an

28476

<a href="#st_005fboulder">st_boulder</a> hitting and of course messages will cause the pulsing, too.

28477

28478

Even though the three major variants can be set by attributes, they are mutual

28479

exclusive. A ‘<samp>hollow</samp>’ stone is never movable or solid and vice versa. That

28480

means setting one of these basic attributes will reset the others to their

28481

defaults.

28482

28483

A movable stoneimpulse being pushed will pulse due to the actor hit at the

28484

new grid position. Even when it is pushed while pulsing it will continue the

28485

running pulse animation on the new grid and if necessary it will repulse to

28486

guarantee that impulses are send to the neighboring stones at the new position.

28487

28488

But if an actor with a revealed <a href="#it_005fmagicwand">it_magicwand</a> pushes a movable stoneimpulse

28489

it will move without any additional pulse.

28490

28491

In general stoneimpulse stones are very responsive to actor contacts. The

28492

slightest touch is sufficient to cause a pulsing. Hollow stones will shatter

28493

actors beneath it while pulsing.

28494

28495

Hollow stoneimpulse stones are transparent to laserlight and thus do not react.

28496

But all other stones do pulse. A standard not ‘<samp>steady</samp>’ stoneimpulse will

28497

pulse just one time on each new added light beam. But if you set ‘<samp>steady</samp>’

28498

to <code>true</code> the stone will continue pulsing as long as a single beam hits

28499

one of its sides.

28500

28501

An <a href="#st_005fboulder">st_boulder</a> that hits a stoneimpulse causes it to pulse once. The

28502

impulse will not backfire onto the <a href="#st_005fboulder">st_boulder</a>. It will just propagate to

28503

the other three directions. Thus the boulder remains aside the stoneimpulse. But

28504

when the stoneimpulse gets activated otherwise it will push back the boulder,

28505

which will in return hit the stoneimpulse again.

28506

28507

An <a href="#ot_005fcannonball">ot_cannonball</a> emitted from an <a href="#st_005fspitter">st_spitter</a> and now falling onto

28508

a stoneimpulse causes it to pulse, too.

28509

28510

On a chain of stoneimpulse stones the pulsing will propagate along the chain

28511

without backfiring, as the previous stone is still active when its successor

28512

impulses. This feature lets propagate a linear front of impulses through a field

28513

of stoneimpulse stones as expected.

28514

28515

If you want to setup a linear circle of stoneimpulse stones with an impulse

28516

wandering around the circle in one direction forever, you should insert one

28517

‘<samp>st_stoneimpulse_new</samp>’ into the chain. According to the

28518

<a href="#Snapshot-Principle">Snapshot Principle</a> it is a stone that is just about to start pulsing.

28519

You need to set the attribute ‘<samp>orientation</samp>’, which is just evaluated for

28520

new stones when set to the grid. It takes the incoming direction of the impulse

28521

when it reached the new stone. E.g. an orientation of east means that the stone

28522

received an impulse from a stone located west of it which was bound to east.

28523

Thus the stone will emit impulses to all directions but west.

28524

28525

Impulse stones will be destroyed by <a href="#it_005fdynamite">it_dynamite</a> exploding on one of the

28526

eight neighboring grid positions while the stone is enlightened by a laser. But

28527

other explosions, including <a href="#it_005fbomb">it_bomb</a>, will not effect stoneimpulse stones.

28528

28529

28530

<dt> Attributes:</dt>

28531

<dd>

28532

28533

<dt> movable   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

28534

<dd>Movable stones are not hollow.

28535

</dd>

28536

<dt> hollow   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

28537

<dd>Hollow stones are neither movable, nor steady.

28538

</dd>

28539

<dt> steady   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

28540

<dd>Steady stones send continuous impulses while exposed to laser light. Steady stones

28541

are not hollow.

28542

</dd>

28543

</dl>

28544

28545

</dd>

28546

<dt> Messages:</dt>

28547

<dd>

28548

28549

<dt> signal   See section <a href="#signal">signal</a></dt>

28550

<dd>Pulse at a value of ‘<samp>1</samp>’.

28551

</dd>

28552

</dl>

28553

28554

</dd>

28555

<dt> Action: none</dt>

28556

<dt> Variants:</dt>

28557

28558

<dt> <img src="images/st_stoneimpulse.png" alt="images/st_stoneimpulse"> st_stoneimpulse

28559

</dt>

28560

<dt> <img src="images/st_stoneimpulse.png" alt="images/st_stoneimpulse"> st_stoneimpulse_movable: movable = <code>true</code>

28561

</dt>

28562

<dt> <img src="images/st_stoneimpulse_hollow.png" alt="images/st_stoneimpulse_hollow"> st_stoneimpulse_hollow: hollow = <code>true</code>

28563

</dt>

28564

<dt> <img src="images/st_stoneimpulse_6.png" alt="images/st_stoneimpulse_6"> st_stoneimpulse_steady: steady = <code>true</code>

28565

</dt>

28566

<dt> <img src="images/st_stoneimpulse.png" alt="images/st_stoneimpulse"> st_stoneimpulse_new:

28567

</dt>

28568

<dd>A stone that is about to pulse when being set.

28569

</dd>

28570

</dl>

28571

28572

</dd>

28573

</dl>

28574

28575

28576

28577

28578

28579

28580

28581

28582

28583

28584

28585

28586

28587

28588

28589

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

28590

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

28591

28592

</tr></table>

28593

28594

<h3 class="subsection">9.5.59 st_surprise</h3>

28595

28596

28597

A stone that transforms into a random stone as soon as an actor hits it.

28598

28599

The replacement stone is a random one out of a given selection. You can set

28600

the ‘<samp>selection</samp>’ attribute with tokens of strings. Every string needs either

28601

to be an <a href="#Object-Kind">Object Kind</a> or a tile key prefixed by an equal sign ‘<samp>=</samp>’.

28602

28603

<table><tr><td> </td><td><pre class="example">ti["b"] = {"st_brake"}

28604

ti["d"] = {"st_death"}

28605

ti["s"] = {"st_surprise", selection={"st_chess", "=b", "=d", "=d"}}

28606

</pre></td></tr></table>

28607

28608

The replacement stone is randomly chosen out of the given selection. By listing

28609

a stone several times you can take influence on the likelihood.

28610

28611

The tile declarations referenced by a key may even contain objects besides

28612

stone. But you should make rare and proper usage of this feature.

28613

28614

Prior replacing the surprise stone the surprise stone will perform its action.

28615

You can use this action to modify the selection or to set objects on your own.

28616

28617

The surprise stone is killed by any replacement stone set to the grid position.

28618

If your selection does not resolve to a stone you may need to add <code>"st_nil"</code>

28619

to the replacement tile declaration.

28620

28621

28622

<dt> Attributes:</dt>

28623

28624

<dt> selection,   values: tokens of stone kinds and tile keys;   default: <code>{"st_grate_cross", "st_death", "st_surprise", "st_lightglass_hollow", "st_knight", "st_thief", "st_flat_breakable", "st_flat_breaking"}</code></dt>

28625

</dl>

28626

28627

</dd>

28628

<dt> Messages:</dt>

28629

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

28630

<dt> Variants:</dt>

28631

28632

<dt> <img src="images/st_surprise.png" alt="images/st_surprise"> st_surprise

28633

</dt>

28634

</dl>

28635

</dd>

28636

</dl>

28637

28638

28639

28640

28641

28642

28643

28644

28645

28646

28647

28648

28649

28650

28651

28652

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

28653

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

28654

28655

</tr></table>

28656

28657

28658

28659

28660

A swap stone can exchange its position with a neighboring stone on the side

28661

in direction of the initiating impulse. It is not freely movable by pushes.

28662

But when an actor hits a swap stone and another stone is located on the opposite

28663

side of the swap stone, both stones will exchange their positions. The swap will

28664

also be performed when the swap stone receives a stone impulse via an

28665

<a href="#ot_005fwire">ot_wire</a> or a neighboring <a href="#st_005fstoneimpulse">st_stoneimpulse</a>. A similar stone it the

28666

<a href="#st_005fpull">st_pull</a>, that exchanges with stones in the reverse direction of the

28667

initiating impulse.

28668

28669

An existing stone exchange partner is mandatory. Nearly all stones can be

28670

swapped. Just connected <a href="#Cluster-Stones">Cluster Stones</a> building a block, <a href="#st_005foxyd">st_oxyd</a>

28671

configured as being ‘<samp>static</samp>’, and another swap stone or <a href="#st_005fpull">st_pull</a> that

28672

is currently engaged in an own stone exchange operation will refuse swapping.

28673

28674

Stone exchanges will not cause item hit transformations as caused by push moved

28675

stones. But the exchanged stones will react on the new floor, e.g. causing

28676

<a href="#st_005fbox">st_box</a> to sink into water.

28677

28678

Further on the exchange is atomic concerning <a href="#it_005ftrigger">it_trigger</a> detection and

28679

laser light transparency. If the exchanged stone is transparent, the light

28680

will pass on every time slice just on one of the two grids. If the exchanged

28681

stone is floating and does not press <a href="#it_005ftrigger">it_trigger</a>s, the swap stone will

28682

press just one trigger, releasing the trigger of the old position before

28683

pressing the new position’s trigger like any other stone being pushed from one

28684

grid to the next.

28685

28686

28687

<dt> Attributes: none</dt>

28688

<dt> Messages: none</dt>

28689

<dt> Action: none</dt>

28690

<dt> Variants:</dt>

28691

28692

<dt> <img src="images/st_swap.png" alt="images/st_swap"> st_swap

28693

</dt>

28694

</dl>

28695

</dd>

28696

</dl>

28697

28698

28699

28700

28701

28702

28703

28704

28705

28706

28707

28708

28709

28710

28711

28712

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

28713

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

28714

28715

</tr></table>

28716

28717

<h3 class="subsection">9.5.61 st_switch</h3>

28718

28719

28720

A classical on/off switch that toggles its state on actors hitting the stone.

28721

Of course other objects can send messages on actions to make this switch turning.

28722

28723

Three variants of the switch do exist. A neutral, grey colored one that reacts

28724

on any actor hits, and a black and a white colored switch. These last two

28725

switches will react only if hit by actors of matching color.

28726

28727

If a switch turns on or off there will be a short delay until it reaches the

28728

new state and performs it actions. If you need a switch without delay you

28729

need to set the ‘<samp>instant</samp>’ attribute.

28730

28731

28732

<dt> Attributes:</dt>

28733

<dd>

28734

28735

<dt> state,   values: <code>ON</code>, <code>OFF</code>;   default: <code>OFF</code>   See section <a href="#state">state</a></dt>

28736

<dt> color   values: <code>nil</code>, <code>BLACK</code>, <code>WHITE</code>;   default: <code>nil</code></dt>

28737

<dd>The color of the switch that needs to match the hitting actor to cause a toggle.

28738

The default ‘<samp>nil</samp>’ color is a grey switch that matches all actors, marbles,

28739

pearls or killers of any color as well as all other actors.

28740

</dd>

28741

<dt> instant   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

28742

<dd>A default switch requires a short time equivalent to the animation until the

28743

new state is reached and the actions are performed. An instant switch jumps

28744

directly into the new state.

28745

</dd>

28746

</dl>

28747

28748

</dd>

28749

<dt> Messages:</dt>

28750

<dd>

28751

28752

<dt> signal   See section <a href="#signal">signal</a></dt>

28753

<dd>Switches on at value ‘<samp>1</samp>’, and off at values ‘<samp>0</samp>’.

28754

</dd>

28755

<dt> on   See section <a href="#on">on</a></dt>

28756

<dt> off   See section <a href="#off">off</a></dt>

28757

</dl>

28758

28759

</dd>

28760

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

28761

<dt> Variants:</dt>

28762

<dd>

28763

28764

<dt> <img src="images/st_switch.png" alt="images/st_switch"> st_switch

28765

</dt>

28766

<dt> <img src="images/st_switch_black.png" alt="images/st_switch_black"> st_switch_black: color = <code>BLACK</code>

28767

</dt>

28768

<dt> <img src="images/st_switch_white.png" alt="images/st_switch_white"> st_switch_white: color = <code>WHITE</code>

28769

</dt>

28770

</dl>

28771

28772

</dd>

28773

</dl>

28774

28775

28776

28777

28778

28779

28780

28781

28782

28783

28784

28785

28786

28787

28788

28789

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

28790

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

28791

28792

</tr></table>

28793

28794

<h3 class="subsection">9.5.62 st_thief</h3>

28795

28796

28797

A thief steals an item from the player’s inventory when it is hit by an owned

28798

actor. Unfortunately the thief is visually indistinguishable from a

28799

<a href="#st_005fbluegray">st_bluegray</a>.

28800

28801

The item is not directly stolen at the moment of the hit. The hit itself just

28802

causes the thief to emerge from his hiding-place. The thief steals from the

28803

actor that did hit the stone at the moment of maximum visibility. He takes

28804

a random item from the owner’s inventory. But he just will steal an item if

28805

the actor is not shielded due to an activated <a href="#it_005fumbrella">it_umbrella</a>.

28806

28807

Thieves have an addiction to alcohol. Thus they get drunken and inactive if

28808

they happen to steal a bottle filled with stuff.

28809

28810

Thieves have an enemy - the <a href="#st_005fchess">st_chess</a>. If a chess stone is pushed onto

28811

a thief it will capture the thief, sober or drunken. The thief stone vanishes

28812

and the chess stone jumps onto its position. But the thief will leave behind

28813

on the grid all stolen items in his own <a href="#it_005fbag">it_bag</a>. If an item happens to

28814

be positioned beneath the captured thief stone, this item will be added to

28815

the thief’s bag, too. If the thief has not stolen any items he leaves no empty

28816

bag.

28817

28818

28819

<dt> Attributes: none</dt>

28820

<dt> Messages: none</dt>

28821

<dt> Action: none</dt>

28822

<dt> Variants:</dt>

28823

28824

<dt> <img src="images/st_bluegray.png" alt="images/st_bluegray"> st_thief: hidden

28825

</dt>

28826

<dt> <img src="images/st_thief.png" alt="images/st_thief"> st_thief: showing up at the moment when stealing items

28827

</dt>

28828

<dt> <img src="images/st_thief_capture.png" alt="images/st_thief_capture"> st_thief: when being captured

28829

</dt>

28830

<dt> <img src="images/st_thief_drunken.png" alt="images/st_thief_drunken"> st_thief: drunken thief

28831

</dt>

28832

</dl>

28833

</dd>

28834

</dl>

28835

28836

28837

28838

28839

28840

28841

28842

28843

28844

28845

28846

28847

28848

28849

28850

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

28851

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

28852

28853

</tr></table>

28854

28855

<h3 class="subsection">9.5.63 st_timer</h3>

28856

28857

28858

This stone can be used to trigger a delayed single or periodic events. An

28859

active, switched on timer is usually visualized by an animation. An inactive,

28860

switched off timer shows a static image. An alternative to an invisible timer

28861

stone is an <a href="#ot_005ftimer">ot_timer</a> gadget.

28862

28863

Note that this is an exceptional object as its default state is ‘<samp>ON</samp>’ to

28864

support the most common case of immediately running timers.

28865

28866

A single shot, not looping timer will send an action value of ‘<samp>true</samp>’. A

28867

looping timer will alternate the boolean action values starting with value

28868

‘<samp>true</samp>’. You can use <a href="#inverse">inverse</a> to start with a value of ‘<samp>false</samp>’.

28869

28870

If you stop a timer by switching it off, no further events will be performed.

28871

Restarting the timer by switching it on again will restart the timer like

28872

a new timer.

28873

28874

The time interval to the first event and between subsequent events can be relied

28875

on to an accuracy of 0.01 seconds. But due to performance reasons and visibility

28876

of the reactions timers should not be set to intervals below 0.1 seconds. An

28877

interval of less than 0.01 seconds is not valid for a looping timer.

28878

28879

28880

<dt> Attributes:</dt>

28881

<dd>

28882

28883

<dt> state,   values: <code>ON</code>, <code>OFF</code>;   default: <code>ON</code>   See section <a href="#state">state</a></dt>

28884

<dd>An ‘<samp>ON</samp>’ state timer is running. A timer in state ‘<samp>OFF</samp>’ is reset and

28885

waiting for reactivation.

28886

</dd>

28887

<dt> invisible   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

28888

<dd>An invisible timer is totally transparent. But the user may notice it, as actors

28889

cannot pass and other stones cannot be moved onto the same grid position.

28890

</dd>

28891

<dt> interval   values: positive number;   default: <code>1.0</code></dt>

28892

<dd>Number of seconds until the first and between subsequent events. The interval

28893

must be larger or equal 0.01 seconds for looping timers.

28894

</dd>

28895

<dt> loop   values: <code>true</code>, <code>false</code>;   default: <code>true</code></dt>

28896

<dd>A looping timer will send periodic events.

28897

</dd>

28898

</dl>

28899

28900

</dd>

28901

<dt> Messages:</dt>

28902

<dd>

28903

28904

<dt> signal   See section <a href="#signal">signal</a></dt>

28905

<dd>Switches on at value ‘<samp>1</samp>’, and off at values ‘<samp>0</samp>’.

28906

</dd>

28907

<dt> on   See section <a href="#on">on</a></dt>

28908

<dt> off   See section <a href="#off">off</a></dt>

28909

</dl>

28910

28911

</dd>

28912

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

28913

<dd>The action value starts with ‘<samp>true</samp>’ and alternates on every event between

28914

‘<samp>false</samp>’ and ‘<samp>true</samp>’. A timer that is reset starts again with value

28915

‘<samp>true</samp>’

28916

28917

</dd>

28918

<dt> Variants:</dt>

28919

28920

<dt> <img src="images/st_timer_3.png" alt="images/st_timer_3"> st_timer: state = <code>OFF</code>

28921

</dt>

28922

<dt> <img src="images/st_timer.png" alt="images/st_timer"> st_timer: state = <code>ON</code>

28923

</dt>

28924

</dl>

28925

</dd>

28926

</dl>

28927

28928

28929

28930

28931

28932

28933

28934

28935

28936

28937

28938

28939

28940

28941

28942

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

28943

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

28944

28945

</tr></table>

28946

28947

<h3 class="subsection">9.5.64 st_turnstile</h3>

28948

28949

28950

A turnstile is a stone cluster that consists of a central pivot, this

28951

‘<samp>st_turnstile</samp>’, and up to four neighboring <a href="#st_005fturnstilearm">st_turnstilearm</a>s of

28952

connecting orientations. When one the arms is hit by an actor or receives a

28953

stone pushing impulse by another object (e.g. ‘<samp>st_rotator</samp>’, ‘<samp>ot_wire</samp>’,

28954

‘<samp>it_puller</samp>’, ...), the whole cluster turns by 90 degrees into the impulse

28955

direction. Of course the turnstile complex just turns if it is not blocked by

28956

other stones in its surrounding. Even movable stones will block turnstiles.

28957

28958

There are two ‘<samp>flavor</samp>’s of turnstiles. The common ‘<samp>red</samp>’ version

28959

pulls only the actor, that did hit the arm. It keeps it behind the

28960

‘<samp>st_turnstilearm</samp>’ and shatters all others in its surrounding. Whereas the

28961

‘<samp>green</samp>’ version pushes all actors with its attached ‘<samp>st_turnstilearm</samp>’s

28962

and keeps them in front of the arms. Just actors being in range of the arms will

28963

be pushed. That means that they need to be in a distance of less than 1.5 grids

28964

to the center of the pivot. Thus actors located at the very edge of the

28965

diagonal grid positions will not be pushed. As actors can not be moved out of

28966

the world, a green turnstile positioned at the level border that moves an arm

28967

to the border will shatter actors instead.

28968

28969

Any actor moved by a turnstile is directly warped to its new position without

28970

touching any grid in between. Thus actors can pass abyss or water floors,

28971

but they will not grab any items located on the grid positions in between.

28972

The relative position of an actor within the grid is maintained during its

28973

circular move. Thus two small actors moved at the same time keep their relative

28974

positioning. It is guaranteed that any moved actors will fall even into a tiny

28975

<a href="#it_005fmeditation">it_meditation</a>_dent that is positioned at the destination grid.

28976

28977

Items in the range of the rotating arms will act like a stone being pushed over

28978

them.

28979

28980

When green turnstiles push actors to a diagonal grid position they will push

28981

away an <a href="#st_005fturnstilearm">st_turnstilearm</a>, and just this single kind of stone, if it is

28982

located on this target grid. This feature can be used to intertwine several

28983

turnstiles as it can be seen in the level ‘<samp>ZigZag</samp>’.

28984

28985

There are two other ways of coupling turnstiles. You can simply set another

28986

‘<samp>st_turnstile</samp>’ as the target of a first one and perform a ‘<samp>signal</samp>’

28987

action. This will turn both turnstiles in the same direction. But if one is

28988

blocked the rotations will desynchronize.

28989

28990

Another way is the coupling of two <a href="#st_005fturnstilearm">st_turnstilearm</a>s via an <a href="#ot_005fwire">ot_wire</a>.

28991

A turnstile will propagate its rotation impulses via an wire that is connected

28992

at one of its arms. Two turnstiles connected by wired arms will resynchronize in their

28993

rotation even if one of them is temporarily blocked.

28994

28995

Turnstiles can be turned by standard messages and attributes. They do even

28996

evaluate the turns and keep the attribute ‘<samp>orientation</samp>’ up to date for

28997

easy read evaluation of the current turnstile orientation.

28998

28999

29000

<dt> Attributes:</dt>

29001

29002

<dt> flavor   values: <code>"red"</code>, <code>"green"</code>;   default: <code>"red"</code></dt>

29003

<dd>The distinguishing color of the pivot that signals the behaviour.

29004

</dd>

29005

<dt> counterclock   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

29006

<dd>The standard turning direction is clockwise. Use this attribute to revert the

29007

direction.

29008

29009

</dd>

29010

<dt> orientation,   values: <code>NORTH</code>, <code>EAST</code>, <code>SOUTH</code>, <code>WEST</code>;   default: <code>NORTH</code></dt>

29011

<dd>The orientation of the turnstile that is only visible by its arms. Setting

29012

this attribute just defines a new base, but does not turn the turnstile as the

29013

orientation would not be defined. But every rotation does update this attribute

29014

relative to its previous value.

29015

</dd>

29016

</dl>

29017

29018

</dd>

29019

<dt> Messages:</dt>

29020

<dd>

29021

29022

<dt> signal   See section <a href="#signal">signal</a></dt>

29023

<dd>Rotates the turnstile counterclockwise on ‘<samp>1</samp>’, and clockwise at values ‘<samp>0</samp>’.

29024

</dd>

29025

29026

<dd>Turns in turning direction as defined by attribute ‘<samp>counterclock</samp>’.

29027

</dd>

29028

<dt> turnback</dt>

29029

<dd>Turns in opposite turning direction as defined by attribute ‘<samp>counterclock</samp>’.

29030

</dd>

29031

</dl>

29032

29033

</dd>

29034

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

29035

<dd>At the end of each turn the action is performed with a value of ‘<samp>true</samp>’

29036

on counterclock turns and ‘<samp>false</samp>’ on clockwise turns.

29037

29038

</dd>

29039

<dt> Variants:</dt>

29040

29041

<dt> <img src="images/st_turnstile.png" alt="images/st_turnstile"> st_turnstile: flavor = <code>"red"</code>

29042

</dt>

29043

<dt> <img src="images/st_turnstile.png" alt="images/st_turnstile"> st_turnstile_red: flavor = <code>"red"</code>

29044

</dt>

29045

<dt> <img src="images/st_turnstile_green.png" alt="images/st_turnstile_green"> st_turnstile_green: flavor = <code>"green"</code>

29046

</dt>

29047

</dl>

29048

</dd>

29049

</dl>

29050

29051

29052

29053

29054

29055

29056

29057

29058

29059

29060

29061

29062

29063

29064

29065

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

29066

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

29067

29068

</tr></table>

29069

29070

<h3 class="subsection">9.5.65 st_turnstilearm</h3>

29071

29072

29073

An arm that usually connects to an <a href="#st_005fturnstile">st_turnstile</a> pivot building a turnstile

29074

cluster. The arm’s subkind suffix, its state and orientation are named according

29075

to the arm’s position within the turnstile cluster. Thus a ‘<samp>NORTH</samp>’ arm has

29076

a single standard connection of <code>"s"</code>, the reverse orientation.

29077

29078

As long as a turnstile arm is not connected to a pivot it is a free movable

29079

stone. Intentionally it is visually indistinguishable from a <a href="#st_005fpuzzle">st_puzzle</a>

29080

with the same connections. But neither an arm will not connect to other

29081

<a href="#st_005fpuzzle">st_puzzle</a> nor a puzzle to a pivot.

29082

29083

An arm is connected to a pivot on a neighboring grid position solely by a

29084

matching connection. It is no longer freely movable. All its impulses will turn

29085

the <a href="#st_005fturnstile">st_turnstile</a> cluster instead.

29086

29087

A special move of an arm is due to actors being moved by another green

29088

<a href="#st_005fturnstile">st_turnstile</a> to its position. The arm receives an impulse by the other

29089

pivot and will either move straight forward or turn its own pivot if being

29090

part of a cluster.

29091

29092

The orientation of an arm can be set by attribute or messages. Neither way will

29093

generate an impulse to turn a connected turnstile cluster. The arm will be

29094

reorientated alone.

29095

29096

29097

<dt> Attributes:</dt>

29098

<dd>

29099

29100

<dt> state,   values: <code>NORTH</code>, <code>EAST</code>, <code>SOUTH</code>, <code>WEST</code>;   default: <code>NORTH</code>   See section <a href="#state">state</a></dt>

29101

<dd>The position of an arm in a turnstile cluster.

29102

29103

</dd>

29104

<dt> orientation,   values: <code>NORTH</code>, <code>EAST</code>, <code>SOUTH</code>, <code>WEST</code>;   default: <code>NORTH</code></dt>

29105

<dd>The position of an arm in a turnstile cluster.

29106

</dd>

29107

<dt> connections   values: string;   default: <code>"s"</code></dt>

29108

<dd>Describes the <a href="#st_005fpuzzle">st_puzzle</a> like connection that is the opposite of the

29109

orientation. The string is a string of a single character describing the

29110

sole connection.

29111

</dd>

29112

</dl>

29113

29114

</dd>

29115

<dt> Messages:</dt>

29116

<dd>

29117

29118

29119

</dd>

29120

<dt> orientate,   value type: orientation</dt>

29121

<dd>Change the orientation to the given orientation value. The <a href="#st_005ffourswitch">st_fourswitch</a>

29122

provides a compatible action which allows you to set an arm as

29123

target and this message as action.

29124

</dd>

29125

</dl>

29126

29127

</dd>

29128

<dt> Action: none</dt>

29129

<dt> Variants:</dt>

29130

29131

<dt> <img src="images/st_puzzle_blue_3.png" alt="images/st_puzzle_blue_3"> st_turnstilearm: orientation = <code>NORTH</code>

29132

</dt>

29133

<dt> <img src="images/st_puzzle_blue_3.png" alt="images/st_puzzle_blue_3"> st_turnstilearm_n: orientation = <code>NORTH</code>

29134

</dt>

29135

<dt> <img src="images/st_puzzle_blue_2.png" alt="images/st_puzzle_blue_2"> st_turnstilearm_e: orientation = <code>EAST</code>

29136

</dt>

29137

<dt> <img src="images/st_puzzle_blue_c.png" alt="images/st_puzzle_blue_c"> st_turnstilearm_s: orientation = <code>SOUTH</code>

29138

</dt>

29139

<dt> <img src="images/st_puzzle_blue_b.png" alt="images/st_puzzle_blue_b"> st_turnstilearm_w: orientation = <code>WEST</code>

29140

</dt>

29141

</dl>

29142

</dd>

29143

</dl>

29144

29145

29146

29147

29148

29149

29150

29151

29152

29153

29154

29155

29156

29157

29158

29159

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

29160

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

29161

29162

</tr></table>

29163

29164

<h3 class="subsection">9.5.66 st_volcano</h3>

29165

29166

29167

A volcano stone spreads slowly to neighboring grid positions filling up

29168

complete areas and will just stop on boundaries set by other stones.

29169

29170

A volcano can either start by the setting of an ‘<samp>ACTIVE</samp>’ variant, by

29171

an inactive ‘<samp>IDLE</samp>’ variant being triggered by a message or a hitting

29172

<a href="#st_005fboulder">st_boulder</a>, or by an <a href="#it_005fseed">it_seed</a> of flavor <code>volcano</code> being dropped

29173

or triggered.

29174

29175

Once being activated a volcano stone spreads randomly to its direct neighbor

29176

positions. Even though the new set volcano seeds can be passed by actors

29177

without harm for a short period of time the volcano gets lethal while growing.

29178

After reaching its full size a volcano remains for a random time in an active,

29179

glowing state spreading to neighbour positions. During this phase an actor

29180

with a revealed <a href="#it_005fhammer">it_hammer</a> can destroy the active volcano stone.

29181

29182

The spreading of the volcano can be made ‘<samp>secure</samp>’ by setting this attribute

29183

to ‘<samp>true</samp>’. Per default the spreading in not secure and a volcano may

29184

stop spreading with a certain chance anywhere, but especially in narrow gateways.

29185

In contrast a secure volcano remains active until it is guaranteed that all its

29186

neighbor grid positions will be filled with volcano stones.

29187

29188

After its active phase a volcano reaches its final inactive state and can not

29189

be reactivated anymore.

29190

29191

A volcano stone will press any <a href="#it_005ftrigger">it_trigger</a> as soon as it starts growing.

29192

29193

!!Work in progress!! special behaviour on items and floors may yet be added

29194

29195

29196

<dt> Attributes:</dt>

29197

29198

<dt> state,   values: <code>IDLE</code>, <code>ACTIVE</code>;   default: <code>IDLE</code>   See section <a href="#state">state</a></dt>

29199

<dd>Inactive, finished and breaking volcano will report an ‘<samp>IDLE</samp>’ state,

29200

new, growing and active volcano will report an ‘<samp>ACTIVE</samp>’ state. An inactive

29201

volcano can be activated by setting the state to ‘<samp>ACTIVE</samp>’. All other

29202

attempts to set the state will be silently ignored.

29203

</dd>

29204

<dt> secure   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

29205

<dd>A secure volcano will spread a complete area with guarantee.

29206

</dd>

29207

</dl>

29208

29209

</dd>

29210

<dt> Messages:</dt>

29211

29212

<dt> toggle   See section <a href="#toggle">toggle</a></dt>

29213

<dd>Activates an inactive volcano stone.

29214

</dd>

29215

</dl>

29216

29217

</dd>

29218

<dt> Variants:</dt>

29219

29220

<dt> <img src="images/st_flat.png" alt="images/st_flat"> st_volcano: state = <code>IDLE</code>

29221

</dt>

29222

<dt> <img src="images/st_flat.png" alt="images/st_flat"> st_volcano_idle: state = <code>IDLE</code>

29223

</dt>

29224

<dt> <img src="images/st_quake_3.png" alt="images/st_quake_3"> st_volcano_active: state = <code>ACTIVE</code>

29225

</dt>

29226

<dt> <img src="images/it_seed.png" alt="images/it_seed"> st_volcano_new:

29227

</dt>

29228

<dd>An active volcano starting in the seed like phase.

29229

</dd>

29230

<dt> <img src="images/st_volcano_growing.png" alt="images/st_volcano_growing"> st_volcano_growing:

29231

</dt>

29232

<dd>An active volcano starting in the growing phase.

29233

</dd>

29234

</dl>

29235

</dd>

29236

</dl>

29237

29238

29239

29240

29241

29242

29243

29244

29245

29246

29247

29248

29249

29250

29251

29252

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

29253

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

29254

29255

</tr></table>

29256

29257

<h3 class="subsection">9.5.67 st_window</h3>

29258

29259

29260

A stone made up just of glass window faces. All combinations of window faces with

29261

at least one face are possible. There exist two versions of windows, normal

29262

blue colored glass and green colored safety glass, that is nearly indestructible.

29263

Safety glass is selected by setting the attribute ‘<samp>secure</samp>’ to ‘<samp>true</samp>’.

29264

Every glass face can be weakened by ‘<samp>scratches</samp>’ which are visible in the

29265

shadows.

29266

29267

All windows are transparent to laser light.

29268

29269

Slowly moving actors will bounce from window faces on any side. They can freely

29270

move within the inner part of the window stone. Invisible actors can even pass

29271

the normal blue window faces, but not the green safety glass faces.

29272

29273

Fast moving actors can blast normal blue window faces into smithereens. But too

29274

strong hits will cause marbles to shatter themselves. An actor can lower the

29275

required speed by adding <a href="#it_005fweight">it_weight</a>, by revealing an <a href="#it_005fhammer">it_hammer</a>, or by

29276

weakening the window faces by prior scratching it with an <a href="#it_005fring">it_ring</a>. Green

29277

safety glass windows will never break on actor attacks and actors will not

29278

shatter on hitting safety glass.

29279

29280

Bomb explosions can shatter window faces, too. Normal blue window faces adjacent

29281

to a bomb explosion will break. Green safety glass faces will break only if

29282

prior weakened by an <a href="#it_005fring">it_ring</a> scratch.

29283

29284

Window faces can be rearranged by actors with a revealed <a href="#it_005fwrench">it_wrench</a>.

29285

Pushing a face from the outside may move it to the opposite side of the window.

29286

But it will only move to the opposite side if there is not already a window face.

29287

And additionally the grid position adjacent to the opposite side must be free

29288

of a stone. Just another window stone without an adjacent window face is allowed

29289

on this position. The reason is, that the moving window face will push

29290

non static items and any actors positioned on the affected window grid to the

29291

next grid. If this grid is already occupied by an item, the window grid item

29292

will be <a href="#it_005fsquashed">it_squashed</a>.

29293

29294

Window face rearrangements can also be initiated by an <a href="#it_005fpuller">it_puller</a> dropped

29295

within the window and by the message ‘<samp>inner_pull</samp>’.

29296

29297

Windows do support <a href="#Flood-Spreading">Flood Spreading</a> and <a href="#Fire-Spreading">Fire Spreading</a> through open

29298

faces.

29299

29300

29301

<dt> Attributes:</dt>

29302

<dd>

29303

29304

<dt> faces   values: string;   default: <code>"s"</code></dt>

29305

<dd>Describes the window faces of the stone. The string is a substring of

29306

<code>"nesw"</code> listing the faces. The sequence of the sides, north, east, south,

29307

west, is guaranteed on read access but arbitrary on write access.

29308

</dd>

29309

<dt> secure   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

29310

<dd>Green safety glass is secure, whereas normal blue is not.

29311

</dd>

29312

<dt> scratches   values: string;   default: <code>""</code></dt>

29313

<dd>Describes the scratched window faces of the stone. The string is a substring of

29314

<code>"nesw"</code> listing the affected faces. The sequence of the sides, north, east,

29315

south, west, is guaranteed on read access but arbitrary on write access.

29316

</dd>

29317

</dl>

29318

29319

</dd>

29320

<dt> Messages:</dt>

29321

<dd>

29322

29323

<dt> inner_pull,   value type: orientation</dt>

29324

<dd>Tries to tear the opposite window face into the given orientation.

29325

</dd>

29326

</dl>

29327

29328

</dd>

29329

<dt> Variants:</dt>

29330

29331

<tr><td width="8%"><img src="images/st_window_blue_3.png" alt="images/st_window_blue_3"></td><td width="42%">st_window: faces = <code>"s"</code>, secure = <code>false</code></td><td width="8%"><img src="images/st_window_green_3.png" alt="images/st_window_green_3"></td><td width="42%">st_window: faces = <code>"s"</code>, secure = <code>true</code></td></tr>

29332

<tr><td width="8%"><img src="images/st_window_blue_2.png" alt="images/st_window_blue_2"></td><td width="42%">st_window_w: faces = <code>"w"</code>, secure = <code>false</code></td><td width="8%"><img src="images/st_window_green_2.png" alt="images/st_window_green_2"></td><td width="42%">st_window_w: faces = <code>"w"</code>, secure = <code>true</code></td></tr>

29333

<tr><td width="8%"><img src="images/st_window_blue_3.png" alt="images/st_window_blue_3"></td><td width="42%">st_window_s: faces = <code>"s"</code>, secure = <code>false</code></td><td width="8%"><img src="images/st_window_green_3.png" alt="images/st_window_green_3"></td><td width="42%">st_window_s: faces = <code>"s"</code>, secure = <code>true</code></td></tr>

29334

<tr><td width="8%"><img src="images/st_window_blue_4.png" alt="images/st_window_blue_4"></td><td width="42%">st_window_sw: faces = <code>"sw"</code>, secure = <code>false</code></td><td width="8%"><img src="images/st_window_green_4.png" alt="images/st_window_green_4"></td><td width="42%">st_window_sw: faces = <code>"sw"</code>, secure = <code>true</code></td></tr>

29335

<tr><td width="8%"><img src="images/st_window_blue_b.png" alt="images/st_window_blue_b"></td><td width="42%">st_window_e: faces = <code>"e"</code>, secure = <code>false</code></td><td width="8%"><img src="images/st_window_green_b.png" alt="images/st_window_green_b"></td><td width="42%">st_window_e: faces = <code>"e"</code>, secure = <code>true</code></td></tr>

29336

<tr><td width="8%"><img src="images/st_window_blue_b2.png" alt="images/st_window_blue_b2"></td><td width="42%">st_window_ew: faces = <code>"ew"</code>, secure = <code>false</code></td><td width="8%"><img src="images/st_window_green_b2.png" alt="images/st_window_green_b2"></td><td width="42%">st_window_ew: faces = <code>"ew"</code>, secure = <code>true</code></td></tr>

29337

<tr><td width="8%"><img src="images/st_window_blue_b3.png" alt="images/st_window_blue_b3"></td><td width="42%">st_window_es: faces = <code>"es"</code>, secure = <code>false</code></td><td width="8%"><img src="images/st_window_green_b3.png" alt="images/st_window_green_b3"></td><td width="42%">st_window_es: faces = <code>"es"</code>, secure = <code>true</code></td></tr>

29338

<tr><td width="8%"><img src="images/st_window_blue_b4.png" alt="images/st_window_blue_b4"></td><td width="42%">st_window_esw: faces = <code>"esw"</code>, secure = <code>false</code></td><td width="8%"><img src="images/st_window_green_b4.png" alt="images/st_window_green_b4"></td><td width="42%">st_window_esw: faces = <code>"esw"</code>, secure = <code>true</code></td></tr>

29339

<tr><td width="8%"><img src="images/st_window_blue_c.png" alt="images/st_window_blue_c"></td><td width="42%">st_window_n: faces = <code>"n"</code>, secure = <code>false</code></td><td width="8%"><img src="images/st_window_green_c.png" alt="images/st_window_green_c"></td><td width="42%">st_window_n: faces = <code>"n"</code>, secure = <code>true</code></td></tr>

29340

<tr><td width="8%"><img src="images/st_window_blue_c2.png" alt="images/st_window_blue_c2"></td><td width="42%">st_window_nw: faces = <code>"nw"</code>, secure = <code>false</code></td><td width="8%"><img src="images/st_window_green_c2.png" alt="images/st_window_green_c2"></td><td width="42%">st_window_nw: faces = <code>"nw"</code>, secure = <code>true</code></td></tr>

29341

<tr><td width="8%"><img src="images/st_window_blue_c3.png" alt="images/st_window_blue_c3"></td><td width="42%">st_window_ns: faces = <code>"ns"</code>, secure = <code>false</code></td><td width="8%"><img src="images/st_window_green_c3.png" alt="images/st_window_green_c3"></td><td width="42%">st_window_ns: faces = <code>"ns"</code>, secure = <code>true</code></td></tr>

29342

<tr><td width="8%"><img src="images/st_window_blue_c4.png" alt="images/st_window_blue_c4"></td><td width="42%">st_window_nsw: faces = <code>"nsw"</code>, secure = <code>false</code></td><td width="8%"><img src="images/st_window_green_c4.png" alt="images/st_window_green_c4"></td><td width="42%">st_window_nsw: faces = <code>"nsw"</code>, secure = <code>true</code></td></tr>

29343

<tr><td width="8%"><img src="images/st_window_blue_d.png" alt="images/st_window_blue_d"></td><td width="42%">st_window_ne: faces = <code>"ne"</code>, secure = <code>false</code></td><td width="8%"><img src="images/st_window_green_d.png" alt="images/st_window_green_d"></td><td width="42%">st_window_ne: faces = <code>"ne"</code>, secure = <code>true</code></td></tr>

29344

<tr><td width="8%"><img src="images/st_window_blue_d2.png" alt="images/st_window_blue_d2"></td><td width="42%">st_window_new: faces = <code>"new"</code>, secure = <code>false</code></td><td width="8%"><img src="images/st_window_green_d2.png" alt="images/st_window_green_d2"></td><td width="42%">st_window_new: faces = <code>"new"</code>, secure = <code>true</code></td></tr>

29345

<tr><td width="8%"><img src="images/st_window_blue_d3.png" alt="images/st_window_blue_d3"></td><td width="42%">st_window_nes: faces = <code>"nes"</code>, secure = <code>false</code></td><td width="8%"><img src="images/st_window_green_d3.png" alt="images/st_window_green_d3"></td><td width="42%">st_window_nes: faces = <code>"nes"</code>, secure = <code>true</code></td></tr>

29346

<tr><td width="8%"><img src="images/st_window_blue_d4.png" alt="images/st_window_blue_d4"></td><td width="42%">st_window_nesw: faces = <code>"nesw"</code>, secure = <code>false</code></td><td width="8%"><img src="images/st_window_green_d4.png" alt="images/st_window_green_d4"></td><td width="42%">st_window_nesw: faces = <code>"nesw"</code>, secure = <code>true</code></td></tr>

29347

</table>

29348

</dd>

29349

</dl>

29350

29351

29352

29353

29354

29355

29356

29357

29358

29359

29360

29361

29362

29363

29364

29365

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

29366

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

29367

29368

</tr></table>

29369

29370

<h3 class="subsection">9.5.68 st_yinyang</h3>

29371

29372

29373

A special switch that allows the user to toggle the <a href="#Player-and-Inventory">Player and Inventory</a>

29374

between <code>YIN</code> and <code>YANG</code>.

29375

29376

In contrast to <a href="#it_005fyinyang">it_yinyang</a> the player can not switch at any point of time

29377

but is limited to situations where he can hit the stone by one of the actors

29378

he controls. Of course other objects can send <code>"toggle"</code> messages on

29379

actions to this switch, too. Additionally an <a href="#ot_005fcannonball">ot_cannonball</a> emitted by

29380

an <a href="#st_005fspitter">st_spitter</a> that now happens to fall on top of a yinyang stone

29381

activates it, too.

29382

29383

When being activated the yinyang stone switches from the ‘<samp>IDLE</samp>’ state to

29384

the ‘<samp>ACTIVE</samp>’ state which is animated by a turning yinyang symbol. By

29385

default the player switch takes place at the end of this animation with the

29386

stone returning to its ‘<samp>IDLE</samp>’ state.

29387

29388

If you need a yinyang stone that switches without delay you need to set the

29389

‘<samp>instant</samp>’ attribute to ‘<samp>true</samp>’. The animation is executed after

29390

the switching. Note that even an instant stone variant can not be reactivated

29391

until it returns to its ‘<samp>IDLE</samp>’ state after the completion of the animation.

29392

29393

By default the yinyang stone loops between its two states ‘<samp>IDLE</samp>’ and

29394

‘<samp>ACTIVE</samp>’. This means the user can hit the stone many times causing every

29395

time a player toggle action. But if you set ‘<samp>loop</samp>’ to ‘<samp>false</samp>’ the

29396

yinyang stone will forward to the state ‘<samp>INACTIVE</samp>’ after the next

29397

activation. Thus the user can use this stone just once to toggle the players.

29398

29399

You can use an instance of this stone to toggle the player directly at the

29400

start of the level. Use an ‘<samp>ACTIVE</samp>’ yinyang stone to switch after a short

29401

period of animation, or set additionally ‘<samp>instant</samp>’ to ‘<samp>true</samp>’ to switch

29402

the player before the user can act on <code>YIN</code>.

29403

29404

29405

<dt> Attributes:</dt>

29406

<dd>

29407

29408

<dt> state,   values: <code>IDLE</code>, <code>ACTIVE</code>, <code>INACTIVE</code>;   default: <code>IDLE</code>   See section <a href="#state">state</a></dt>

29409

<dd>An ‘<samp>IDLE</samp>’ yinyang is ready for activation. An ‘<samp>ACTIVE</samp>’ yinyang is

29410

performing its animation and rejects any further attempts to reactivate. An

29411

‘<samp>INACTIVE</samp>’ yinyang reached its final state and can not be reactivated by

29412

actor hits or toggle messages.

29413

</dd>

29414

<dt> instant   values: <code>true</code>, <code>false</code>;   default: <code>false</code></dt>

29415

<dd>A default yinyang stone toggles the player after a short period of animation.

29416

An instant yinyang switches directly with start of the animation.

29417

</dd>

29418

<dt> loop   values: <code>true</code>, <code>false</code>;   default: <code>true</code></dt>

29419

<dd>A looping yinyang returns to ‘<samp>IDLE</samp>’ state after completion of the

29420

‘<samp>ACTIVE</samp>’ state. A yinyang with a ‘<samp>loop</samp>’ value of ‘<samp>false</samp>’ forwards

29421

to the final ‘<samp>INACTIVE</samp>’ state

29422

</dd>

29423

</dl>

29424

29425

</dd>

29426

<dt> Messages:</dt>

29427

<dd>

29428

29429

<dt> toggle   See section <a href="#toggle">toggle</a></dt>

29430

<dd>Activate the yinyang like an actor hitting the stone.

29431

</dd>

29432

</dl>

29433

29434

</dd>

29435

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

29436

<dt> Variants:</dt>

29437

<dd>

29438

29439

<dt> <img src="images/st_yinyang.png" alt="images/st_yinyang"> st_yinyang: state = <code>IDLE</code>

29440

</dt>

29441

<dt> <img src="images/st_yinyang.png" alt="images/st_yinyang"> st_yinyang_active: state = <code>ACTIVE</code>

29442

</dt>

29443

<dt> <img src="images/st_yinyang_inactive.png" alt="images/st_yinyang_inactive"> st_yinyang_inactive: state = <code>INACTIVE</code>

29444

</dt>

29445

<dt> <img src="images/st_yinyang.png" alt="images/st_yinyang"> st_yinyang_instant: instant = <code>true</code>, state = <code>IDLE</code>

29446

</dt>

29447

</dl>

29448

</dd>

29449

</dl>

29450

29451

29452

29453

29454

29455

29456

29457

29458

29459

29460

29461

29462

29463

29464

29465

29466

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

29467

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

29468

29469

</tr></table>

29470

29471

<h2 class="section">9.6 Stone Feature Summaries</h2>

29472

29473

29474

<tr><td align="left" valign="top"><a href="#Transparent-Stones">9.6.1 Transparent Stones</a></td><td>  </td><td align="left" valign="top">

29475

</td></tr>

29476

<tr><td align="left" valign="top"><a href="#Breakable-Stones">9.6.2 Breakable Stones</a></td><td>  </td><td align="left" valign="top">

29477

</td></tr>

29478

</table>

29479

29480

29481

29482

29483

29484

29485

29486

29487

29488

29489

29490

29491

29492

29493

29494

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

29495

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

29496

29497

</tr></table>

29498

29499

<h3 class="subsection">9.6.1 Transparent Stones</h3>

29500

29501

Enigma provides a collection of transparent stones, all similar, but with

29502

different features. Some of them may be passed after the use of an

29503

<a href="#it_005fcherry">it_cherry</a>, others will be just pushed. Some are transparent for lasers,

29504

but not all! This table shows their exact properties.

29505

29506

<table>

29507

<thead><tr><th>class</th><th>kind:</th><th>actor is visible:</th><th>actor is invisible:</th><th>lasertransparent:</th></tr></thead>

29508

<tr><td><a href="#st_005frawglass">st_rawglass</a></td><td>st_rawglass</td><td>rebound</td><td>pass</td><td>yes</td></tr>

29509

<tr><td><a href="#st_005frawglass">st_rawglass</a></td><td>st_rawglass_movable</td><td>push</td><td>pass</td><td>yes</td></tr>

29510

<tr><td><a href="#st_005flightglass">st_lightglass</a></td><td>st_lightglass</td><td>rebound</td><td>pass</td><td>yes</td></tr>

29511

<tr><td><a href="#st_005flightglass">st_lightglass</a></td><td>st_lightglass_movable</td><td>push</td><td>push</td><td>yes</td></tr>

29512

<tr><td><a href="#st_005flightglass">st_lightglass</a></td><td>st_lightglass_hollow</td><td>pass</td><td>pass</td><td>yes</td></tr>

29513

<tr><td><a href="#st_005fdarkglass">st_darkglass</a></td><td>st_darkglass</td><td>rebound</td><td>pass</td><td>no</td></tr>

29514

<tr><td><a href="#st_005fdarkglass">st_darkglass</a></td><td>st_darkglass_movable</td><td>push</td><td>push</td><td>no</td></tr>

29515

<tr><td><a href="#st_005fdarkglass">st_darkglass</a></td><td>st_darkglass_hollow</td><td>pass</td><td>pass</td><td>yes</td></tr>

29516

<tr><td><a href="#st_005fredfiber">st_redfiber</a></td><td>st_redfiber</td><td>rebound</td><td>rebound</td><td>yes</td></tr>

29517

<tr><td><a href="#st_005fpolarswitch">st_polarswitch</a></td><td>st_polarswitch_on</td><td>toggle</td><td>pass</td><td>yes</td></tr>

29518

<tr><td><a href="#st_005fpolarswitch">st_polarswitch</a></td><td>st_polarswitch_off</td><td>toggle</td><td>pass</td><td>no</td></tr>

29519

<tr><td><a href="#st_005fbeads">st_beads</a></td><td>st_beads</td><td>leave</td><td>pass</td><td>no</td></tr>

29520

<tr><td><a href="#st_005flightpassenger">st_lightpassenger</a></td><td>st_lightpassenger_off</td><td>rebound</td><td>rebound</td><td>no</td></tr>

29521

29522

<tr><td><a href="#st_005finvisible">st_invisible</a></td><td>st_invisible</td><td>rebound</td><td>rebound</td><td>no</td></tr>

29523

<tr><td><a href="#st_005finvisible">st_invisible</a></td><td>st_invisible_movable</td><td>push</td><td>push</td><td>no</td></tr>

29524

<tr><td><a href="#st_005finvisible">st_invisible</a></td><td>st_invisible_hollow</td><td>pass</td><td>pass</td><td>no</td></tr>

29525

<tr><td><a href="#st_005fghost">st_ghost</a></td><td>st_ghost_purplemarble</td><td>rebound</td><td>rebound</td><td>no</td></tr>

29526

<tr><td><a href="#st_005fghost">st_ghost</a></td><td>st_ghost_greenbrown</td><td>rebound</td><td>rebound</td><td>yes</td></tr>

29527

<tr><td><a href="#st_005fghost">st_ghost</a></td><td>st_ghost_break</td><td>rebound</td><td>rebound</td><td>yes</td></tr>

29528

</table>

29529

29530

These entries can be memorized as follows: A stone is transparent for laser

29531

light if it is hollow, but not if it is dark. Exception is ‘<samp>st_beads</samp>’,

29532

whose irregular sides would scatter the beam. A stone can always be passed by

29533

invisible actors, with three exceptions: ‘<samp>st_redfiber</samp>’, whose inside is

29534

filled with red stripes, and the two movables ‘<samp>st_lightglass_movable</samp>’ and

29535

‘<samp>st_darkglass_movable</samp>’ which have a non-glass frame which the actor can

29536

use to move the stone. <code>st_rawglass_movable</code> does not have such a frame

29537

and can not be moved by an invisible actor.

29538

29539

29540

29541

29542

29543

29544

29545

29546

29547

29548

29549

29550

29551

29552

29553

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

29554

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

29555

29556

</tr></table>

29557

29558

<h3 class="subsection">9.6.2 Breakable Stones</h3>

29559

29560

29561

29562

29563

29564

29565

29566

29567

29568

29569

29570

29571

29572

29573

29574

29575

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

29576

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

29577

29578

</tr></table>

29579

29580

<h1 class="chapter">10. Actor Objects</h1>

29581

29582

29583

<tr><td align="left" valign="top"><a href="#Actor-Attributes">10.1 Actor Attributes</a></td><td>  </td><td align="left" valign="top"> Common attributes

29584

</td></tr>

29585

<tr><td align="left" valign="top"><a href="#Actors">10.2 Actors</a></td><td>  </td><td align="left" valign="top"> All actors

29586

</td></tr>

29587

<tr><td align="left" valign="top"><a href="#Actor-Features">10.3 Actor Features</a></td><td>  </td><td align="left" valign="top"> Common noteworthy features

29588

</td></tr>

29589

</table>

29590

29591

29592

29593

29594

29595

29596

29597

29598

29599

29600

29601

29602

29603

29604

29605

29606

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

29607

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

29608

29609

</tr></table>

29610

29611

<h2 class="section">10.1 Actor Attributes</h2>

29612

29613

29614

<tr><td align="left" valign="top"><a href="#adhesion-_0028actor_0029">10.1.1 adhesion (actor)</a></td><td>  </td><td align="left" valign="top"> Effectiveness of mousemotion

29615

</td></tr>

29616

<tr><td align="left" valign="top"><a href="#charge">10.1.2 charge</a></td><td>  </td><td align="left" valign="top"> Initial electrical charge

29617

</td></tr>

29618

<tr><td align="left" valign="top"><a href="#controllers">10.1.3 controllers</a></td><td>  </td><td align="left" valign="top"> Mouse

29619

</td></tr>

29620

<tr><td align="left" valign="top"><a href="#color">10.1.4 color</a></td><td>  </td><td align="left" valign="top"> Color

29621

</td></tr>

29622

<tr><td align="left" valign="top"><a href="#essential">10.1.5 essential</a></td><td>  </td><td align="left" valign="top">

29623

</td></tr>

29624

<tr><td align="left" valign="top"><a href="#essential_005fid">10.1.6 essential_id</a></td><td>  </td><td align="left" valign="top">

29625

</td></tr>

29626

<tr><td align="left" valign="top"><a href="#owner">10.1.7 owner</a></td><td>  </td><td align="left" valign="top"> Inventory owner

29627

</td></tr>

29628

<tr><td align="left" valign="top"><a href="#velocity_005fx">10.1.8 velocity_x</a></td><td>  </td><td align="left" valign="top"> Initial velocity

29629

</td></tr>

29630

<tr><td align="left" valign="top"><a href="#velocity_005fy">10.1.9 velocity_y</a></td><td>  </td><td align="left" valign="top"> Initial velocity

29631

</td></tr>

29632

</table>

29633

29634

29635

29636

29637

29638

29639

29640

29641

29642

29643

29644

29645

29646

29647

29648

29649

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

29650

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

29651

29652

</tr></table>

29653

29654

<h3 class="subsection">10.1.1 adhesion (actor)</h3>

29655

29656

The responsiveness of an actor on mouse movements. It is a scalar factor to

29657

the accelerating force applied to the actor. Note that mouse forces are only

29658

applied to an actor if the <a href="#controllers">controllers</a> attribute allows forces at all.

29659

Vice versa you should exclude an actor from mouse forces by usage of the

29660

<a href="#controllers">controllers</a> attribute instead of setting its adhesion to zero. The

29661

adhesion may take negative values, too. Such values correspond to inverse forces.

29662

29663

29664

<dt> Type:   number</dt>

29665

<dt> Values:   float number</dt>

29666

<dt> Default:   <code>0.0</code></dt>

29667

<dt> Access:   read/write</dt>

29668

</dl>

29669

29670

29671

29672

29673

29674

29675

29676

29677

29678

29679

29680

29681

29682

29683

29684

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

29685

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

29686

29687

</tr></table>

29688

29689

<h3 class="subsection">10.1.2 charge</h3>

29690

29691

The initial electrical charge that a new actor starts with when being added to

29692

the world. Actors do charge and recharge by hitting <a href="#st_005fcharge">st_charge</a>. Hits

29693

of charged actors among themselves does not affect their charge load. Each

29694

actor keeps its charge load.

29695

29696

The electrical force on a charged actor is given by its own load and the load

29697

and position of all other charged actors. Note that a constant global factor

29698

<a href="#ElectricStrength">ElectricStrength</a> is applied, too. If this factor is negative, equal

29699

charged actors may even attract each other.

29700

29701

29702

<dt> Type:   number</dt>

29703

<dt> Values:   float number</dt>

29704

<dt> Default:   <code>0.0</code></dt>

29705

<dt> Access:   read/write</dt>

29706

</dl>

29707

29708

29709

29710

29711

29712

29713

29714

29715

29716

29717

29718

29719

29720

29721

29722

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

29723

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

29724

29725

</tr></table>

29726

29727

<h3 class="subsection">10.1.3 controllers</h3>

29728

29729

The players that can control the actor by their mouse movements.

29730

29731

29732

<dt> Type:   number</dt>

29733

<dt> Values:   <code>CTRL_NONE</code>, <code>CTRL_YIN</code>, <code>CTRL_YANG</code>, <code>CTRL_YINYANG</code></dt>

29734

<dt> Default:   <code>CTRL_NONE</code></dt>

29735

<dt> Access:   read/write</dt>

29736

</dl>

29737

29738

29739

29740

29741

29742

29743

29744

29745

29746

29747

29748

29749

29750

29751

29752

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

29753

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

29754

29755

</tr></table>

29756

29757

<h3 class="subsection">10.1.4 color</h3>

29758

29759

The logical color of the actor. All actors besides <a href="#ac_005fmarble">ac_marble</a>s,

29760

<a href="#ac_005fpearl">ac_pearl</a>s and <a href="#ac_005fkiller">ac_killer</a>s will report color <code>nil</code>. The color of

29761

an actor can not be changed, it is a read only attribute.

29762

29763

29764

<dt> Type:   number</dt>

29765

<dt> Values:   <code>BLACK</code>, <code>WHITE</code>, <code>nil</code></dt>

29766

<dt> Default:   <code>nil</code></dt>

29767

<dt> Access:   read only</dt>

29768

</dl>

29769

29770

29771

29772

29773

29774

29775

29776

29777

29778

29779

29780

29781

29782

29783

29784

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

29785

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

29786

29787

</tr></table>

29788

29789

<h3 class="subsection">10.1.5 essential</h3>

29790

29791

Describes the necessity of an actor to be alive in case of multiple actors being

29792

attached to a player. A value ‘<samp>DISPENSABLE</samp>’ marks an actor as not essential.

29793

The player may well continue to play with other actors that he controls which

29794

are still alive. A value of ‘<samp>INDISPENSABLE</samp>’ marks an actor as totally

29795

necessary. If such an actor cannot be resurrected after a death, the player is

29796

essentially dead. A value of ‘<samp>PERKIND</samp>’ marks an actor as partially

29797

essential. Not the actor itself needs to survive but the number of actors of

29798

its kind controlled by the player need to be larger than the number of actors

29799

with value ‘<samp>PERKIND</samp>’. For example, marking 4 out of 5 <a href="#ac_005fpearl">ac_pearl</a> with

29800

‘<samp>PERKIND</samp>’ means that the player is dead if 2 pearls are no longer alive.

29801

29802

Of course shattered or sunken actors will first be resurrected if an

29803

<a href="#it_005fextralife">it_extralife</a> is available and the global attribute <a href="#ConserveLevel">ConserveLevel</a>

29804

allows a resurrection.

29805

29806

For more details about level restart see <a href="#Level-Restart">Level Restart</a>.

29807

29808

29809

<dt> Type:   number</dt>

29810

<dt> Values:   <code>DISPENSABLE</code>, <code>INDISPENSABLE</code>, <code>PERKIND</code></dt>

29811

<dt> Default:   <code></code></dt>

29812

<dt> Access:   read/write</dt>

29813

</dl>

29814

29815

29816

29817

29818

29819

29820

29821

29822

29823

29824

29825

29826

29827

29828

29829

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

29830

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

29831

29832

</tr></table>

29833

29834

<h3 class="subsection">10.1.6 essential_id</h3>

29835

29836

Since a player may control actors of different kinds at the same time, the

29837

essentialness of actors is limited to its kind via this id. It is possible to

29838

group actors of different kinds into an essential group via this id. The engine

29839

keeps this id even if actors are transformed into other kinds like on activation

29840

of an <a href="#it_005fdrop">it_drop</a>.

29841

29842

29843

<dt> Type:   string</dt>

29844

<dt> Values:   any</dt>

29845

<dt> Default:    model name of actor</dt>

29846

<dt> Access:   read/write</dt>

29847

</dl>

29848

29849

29850

29851

29852

29853

29854

29855

29856

29857

29858

29859

29860

29861

29862

29863

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

29864

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

29865

29866

</tr></table>

29867

29868

<h3 class="subsection">10.1.7 owner</h3>

29869

29870

The player that owns the actor. The owner gets all items picked up by an actor

29871

added to his inventory. The ownership of an actor does not influence the

29872

ability of a player to control the actors movements. Note that you need to

29873

assign the value <code>DEFAULT</code> in Lua tables to set the value <code>nil</code> due to

29874

the well known Lua table <a href="#Caveats">Caveats</a>. The other two values <code>YIN</code> and

29875

<code>YANG</code> are common <a href="#state-values">state values</a>.

29876

29877

29878

<dt> Type:   number</dt>

29879

<dt> Values:   <code>YIN</code>, <code>YANG</code>, <code>nil</code></dt>

29880

<dt> Default:   <code>nil</code></dt>

29881

<dt> Access:   read/write</dt>

29882

</dl>

29883

29884

29885

29886

29887

29888

29889

29890

29891

29892

29893

29894

29895

29896

29897

29898

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

29899

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

29900

29901

</tr></table>

29902

29903

<h3 class="subsection">10.1.8 velocity_x</h3>

29904

29905

The velocity into x direction that a new actor starts with when being added to

29906

the world. Even though this attribute is readable it does not reflect the

29907

current velocity of an actor during runtime.

29908

29909

29910

<dt> Type:   number</dt>

29911

<dt> Values:   float number</dt>

29912

<dt> Default:   <code>0.0</code></dt>

29913

<dt> Access:   read/write</dt>

29914

</dl>

29915

29916

29917

29918

29919

29920

29921

29922

29923

29924

29925

29926

29927

29928

29929

29930

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

29931

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

29932

29933

</tr></table>

29934

29935

<h3 class="subsection">10.1.9 velocity_y</h3>

29936

29937

The velocity into y direction that a new actor starts with when being added to

29938

the world. Even though this attribute is readable it does not reflect the

29939

current velocity of an actor during runtime.

29940

29941

29942

<dt> Type:   number</dt>

29943

<dt> Values:   float number</dt>

29944

<dt> Default:   <code>0.0</code></dt>

29945

<dt> Access:   read/write</dt>

29946

</dl>

29947

29948

29949

29950

29951

29952

29953

29954

29955

29956

29957

29958

29959

29960

29961

29962

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

29963

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

29964

29965

</tr></table>

29966

29967

<h2 class="section">10.2 Actors</h2>

29968

29969

29970

29971

</td></tr>

29972

<tr><td align="left" valign="top"><a href="#ac_005fhorse">10.2.2 ac_horse</a></td><td>  </td><td align="left" valign="top">

29973

</td></tr>

29974

<tr><td align="left" valign="top"><a href="#ac_005fkiller">10.2.3 ac_killer</a></td><td>  </td><td align="left" valign="top">

29975

</td></tr>

29976

<tr><td align="left" valign="top"><a href="#ac_005fmarble">10.2.4 ac_marble</a></td><td>  </td><td align="left" valign="top">

29977

</td></tr>

29978

<tr><td align="left" valign="top"><a href="#ac_005fpearl">10.2.5 ac_pearl</a></td><td>  </td><td align="left" valign="top">

29979

</td></tr>

29980

<tr><td align="left" valign="top"><a href="#ac_005frotor">10.2.6 ac_rotor</a></td><td>  </td><td align="left" valign="top">

29981

</td></tr>

29982

29983

</td></tr>

29984

</table>

29985

29986

29987

29988

29989

29990

29991

29992

29993

29994

29995

29996

29997

29998

29999

30000

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

30001

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

30002

30003

</tr></table>

30004

30005

30006

30007

30008

An actor that looks like a small grey ball with two red dots on it. Bugs are

30009

harmless actors that do not affect other actors and they are usually passive.

30010

30011

In contrast to the main actors they can not jump or pass an <a href="#it_005fvortex">it_vortex</a>, and

30012

will not sink, fall or shatter. Bugs are immortal.

30013

30014

Note that you need to set ‘<samp>controllers</samp>’ as well as ‘<samp>adhesion</samp>’ to proper

30015

values if you want a player to control a bug directly. If a bug is owned by a

30016

player <a href="#fl_005fthief">fl_thief</a> and <a href="#st_005fthief">st_thief</a> will steal items from it.

30017

30018

30019

<dt> Attributes: common actor attributes</dt>

30020

30021

<dt> adhesion   values: number;   default: <code>0.0</code>;   See section <a href="#adhesion">adhesion</a></dt>

30022

<dt> controllers   values: <code>CTRL_NONE</code>, <code>CTRL_YIN</code>, <code>CTRL_YANG</code>, <code>CTRL_YINYANG</code>;   default: <code>CTRL_NONE</code>;   See section <a href="#controllers">controllers</a></dt>

30023

<dt> owner   values: <code>YIN</code>, <code>YANG</code>, <code>nil</code>;   default: <code>nil</code>;   See section <a href="#owner">owner</a></dt>

30024

<dt> mass   values: positive float number;   default: <code>0.7</code>;   access: read only</dt>

30025

</dl>

30026

30027

</dd>

30028

<dt> Messages: none</dt>

30029

<dt> Variants:</dt>

30030

<dd>

30031

30032

<dt> <img src="images/ac_bug.png" alt="images/ac_bug"> ac_bug: color = <code>nil</code>, controllers = <code>CTRL_NONE</code>, owner = <code>nil</code>

30033

</dt>

30034

</dl>

30035

30036

</dd>

30037

</dl>

30038

30039

30040

30041

30042

30043

30044

30045

30046

30047

30048

30049

30050

30051

30052

30053

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

30054

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

30055

30056

</tr></table>

30057

30058

<h3 class="subsection">10.2.2 ac_horse</h3>

30059

30060

30061

A large blue disc like actor. It is called a horse because in some future Enigma

30062

release <a href="#ac_005fmarble">ac_marble</a>s and <a href="#ac_005fpearl">ac_pearl</a>s should be able to ride on it.

30063

30064

In contrast to the main actors it can not jump or pass an <a href="#it_005fvortex">it_vortex</a>, and

30065

will not sink, fall or shatter. A horse is immortal.

30066

30067

By default a horse is a passive actor. But nevertheless a horse may move along

30068

its own path. A set of attributes let you control the movement in various ways.

30069

30070

The most simple approach just uses the attributes ‘<samp>destination</samp>’ and

30071

‘<samp>strength</samp>’. You can mark a path marked by an arbitrary number of positions

30072

given as <a href="#destination">destination</a>s. The horse will try to reach the destinations one

30073

in a row with a force given by the strength attribute. As soon as one

30074

destination has been reached the horse targets for the next position and will

30075

start over again as soon as the last position has been reached. In this

30076

‘<samp>steady</samp>’ mode the horse is continously accelerated into the direction of

30077

the next destination target. If it misses the destination on the first approach

30078

it will return by a loop again until it finally passes the target position. This

30079

approach is rather crude and not well suited for a precise control needed if the

30080

horse should hit certain stones or move on a well defined trajectory.

30081

30082

Setting ‘<samp>steady</samp>’ to the value <code>false</code> causes another accelaration

30083

algorithm that will decelerate the horse on approach to its target position.

30084

This allows a very precise control over the path taken by the horse.

30085

30086

Furtheron you can request anytime the index of the current destination target. You

30087

can even set ‘<samp>destidx</samp>’ anytime. Note that this index counts the destination

30088

targets starting with 0 and taking every position into account, which might not

30089

be in sync with the destination token number in case a single token part

30090

addresses several positions at a time.

30091

30092

Furtheron you can control the behaviour of the horse when it reaches the last

30093

destination target. It either stops or restarts if the attribute ‘<samp>loop</samp>’

30094

is set to <code>true</code>.

30095

30096

Setting either ‘<samp>destination</samp>’ to <code>nil</code>, ‘<samp>destidx</samp>’ or ‘<samp>strength</samp>’

30097

to a negative value caues the horse to stop its automatic travel.

30098

30099

On its move a horse tries to reach the target position. But if the target

30100

position is blocked by a stone, the horse continues its travel targeting the

30101

next destination position as soon as it hits the stone. Thus you can use the

30102

horse to toggle <a href="#st_005fswitch">st_switch</a> and other active stones.

30103

30104

Whenever the horse reaches a target position it will perform its action. You

30105

can reset the ‘<samp>destination</samp>’ and other attributes within the callback to

30106

define a new destination target.

30107

30108

Note that you need to set ‘<samp>controllers</samp>’ as well as ‘<samp>adhesion</samp>’ to proper

30109

values if you want a player to control a horse directly.

30110

30111

30112

<dt> Attributes:</dt>

30113

<dd>

30114

30115

<dt> adhesion   values: number;   default: <code>0.0</code>;   See section <a href="#adhesion">adhesion</a></dt>

30116

<dt> controllers   values: <code>CTRL_NONE</code>, <code>CTRL_YIN</code>, <code>CTRL_YANG</code>, <code>CTRL_YINYANG</code>;   default: <code>CTRL_NONE</code>;   See section <a href="#controllers">controllers</a></dt>

30117

<dt> owner   values: <code>YIN</code>, <code>YANG</code>, <code>nil</code>;   default: <code>nil</code>;   See section <a href="#owner">owner</a></dt>

30118

<dt> destination,   values: position or tokens;   default: <code>nil</code>   See section <a href="#destination">destination</a></dt>

30119

<dd>A path given by a sequence of positions.

30120

</dd>

30121

<dt> destidx   values: integer number;   default: <code>0</code></dt>

30122

<dd>The index of the targeted destination.

30123

</dd>

30124

<dt> loop   values: <code>true</code>, <code>false</code>;   default: <code>true</code></dt>

30125

<dd>Flag that determines whether ‘<samp>destidx</samp>’ is reset to its default when the

30126

last destination has been reached.

30127

</dd>

30128

<dt> strength   values: float number;   default: <code>+10.0</code></dt>

30129

<dd>A scalar factor for the horse force that drive it to the next destination.

30130

</dd>

30131

<dt> steady   values: <code>true</code>, <code>false</code>;   default: <code>true</code></dt>

30132

<dd>Flag that determines the chosen acceleration algorithm. On steady force the

30133

actor is continuously accelerated in direction to the next destination. If it

30134

misses the destination it will loop. If steady is false the force will switch

30135

its sign as soon as the actor reaches a critical distance. Thus the actor will

30136

reach the destination with nearly no remaining speed.

30137

</dd>

30138

<dt> mass   values: positive float number;   default: <code>1.2</code>;   access: read only</dt>

30139

</dl>

30140

30141

</dd>

30142

<dt> Messages: none</dt>

30143

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

30144

<dd>Performed on every reached destination position or on stone hits when the

30145

destination position if blocked by a stone.

30146

30147

</dd>

30148

<dt> Variants:</dt>

30149

<dd>

30150

30151

<dt> <img src="images/ac_horse.png" alt="images/ac_horse"> ac_horse: controllers = <code>CTRL_NONE</code>, owner = <code>nil</code>

30152

</dt>

30153

</dl>

30154

30155

</dd>

30156

</dl>

30157

30158

30159

30160

30161

30162

30163

30164

30165

30166

30167

30168

30169

30170

30171

30172

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

30173

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

30174

30175

</tr></table>

30176

30177

<h3 class="subsection">10.2.3 ac_killer</h3>

30178

30179

30180

An actor that looks like a white <a href="#ac_005fpearl">ac_pearl</a>, but is a death bringing killer

30181

ball that shatters <a href="#ac_005fmarble">ac_marble</a>s and <a href="#ac_005fpearl">ac_pearl</a>s on contact.

30182

30183

In contrast to the main actors it can not jump or pass an <a href="#it_005fvortex">it_vortex</a>, and

30184

will not sink, fall or shatter. A killer ball is immortal.

30185

30186

A killer is preset to its standard attribute values, that let both players

30187

control the actor and do assign a higher ‘<samp>adhesion</samp>’ to it than to

30188

<a href="#ac_005fpearl">ac_pearl</a>s.

30189

30190

Note that even though a killer looks quite dangerous, <a href="#fl_005fthief">fl_thief</a> and

30191

<a href="#st_005fthief">st_thief</a> do steal items from them, if the killer is owned by a player.

30192

30193

30194

<dt> Attributes:</dt>

30195

<dd>

30196

30197

<dt> color   values: <code>BLACK</code>, <code>WHITE</code>;   default: <code>WHITE</code>;   access: read only</dt>

30198

<dd>The color of the killer.

30199

</dd>

30200

<dt> adhesion   values: number;   default: <code>2.0</code>;   See section <a href="#adhesion">adhesion</a></dt>

30201

<dt> controllers   values: <code>CTRL_NONE</code>, <code>CTRL_YIN</code>, <code>CTRL_YANG</code>, <code>CTRL_YINYANG</code>;   default: <code>CTRL_YINYANG</code>;   See section <a href="#controllers">controllers</a></dt>

30202

<dt> owner   values: <code>YIN</code>, <code>YANG</code>, <code>nil</code>;   default: <code>nil</code>;   See section <a href="#owner">owner</a></dt>

30203

<dt> mass   values: positive float number;   default: <code>0.7</code>;   access: read only</dt>

30204

</dl>

30205

30206

</dd>

30207

<dt> Messages: none</dt>

30208

<dt> Variants:</dt>

30209

<dd>

30210

30211

<dt> <img src="images/ac_pearl_white.png" alt="images/ac_pearl_white"> ac_killer: color = <code>WHITE</code>, controllers = <code>CTRL_YINYANG</code>, owner = <code>nil</code>

30212

</dt>

30213

<dt> <img src="images/ac_pearl_black.png" alt="images/ac_pearl_black"> ac_killer_black: color = <code>BLACK</code>, controllers = <code>CTRL_YINYANG</code>, owner = <code>nil</code>

30214

</dt>

30215

<dt> <img src="images/ac_pearl_white.png" alt="images/ac_pearl_white"> ac_killer_white: color = <code>WHITE</code>, controllers = <code>CTRL_YINYANG</code>, owner = <code>nil</code>

30216

</dt>

30217

</dl>

30218

30219

</dd>

30220

</dl>

30221

30222

30223

30224

30225

30226

30227

30228

30229

30230

30231

30232

30233

30234

30235

30236

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

30237

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

30238

30239

</tr></table>

30240

30241

<h3 class="subsection">10.2.4 ac_marble</h3>

30242

30243

30244

The main actor in the shape of a large ball, either black or white. Marbles are

30245

versatile actors that can jump, pass <a href="#it_005fvortex">it_vortex</a>, but on the other hand they

30246

can sink, fall and shatter, too.

30247

30248

As long as the ‘<samp>owner</samp>’ has an <a href="#it_005fextralife">it_extralife</a> in his inventory a dying

30249

marble will be resurrected. If no extra life is available a dying actor ends

30250

up in the ‘<samp>state</samp>’ dead and can no longer be controlled.

30251

30252

The marbles are preset to their standard attribute values. A recoloring of

30253

marbles is not possible. The marbles state changes due to events and can be

30254

read only, too.

30255

30256

30257

<dt> Attributes:</dt>

30258

<dd>

30259

30260

<dt> state,   values: <code>ALIVE</code>, <code>DEAD</code>;   default: <code>ALIVE</code>;   See section <a href="#state">state</a>;   access: read only</dt>

30261

<dt> color   values: <code>BLACK</code>, <code>WHITE</code>;   default: <code>BLACK</code>;   access: read only</dt>

30262

<dd>The color of the marble.

30263

</dd>

30264

<dt> adhesion   values: number;   default: <code>1.0</code>;   See section <a href="#adhesion">adhesion</a></dt>

30265

<dt> controllers   values: <code>CTRL_NONE</code>, <code>CTRL_YIN</code>, <code>CTRL_YANG</code>, <code>CTRL_YINYANG</code>;   default: <code>CTRL_NONE</code>;   See section <a href="#controllers">controllers</a></dt>

30266

<dt> owner   values: <code>YIN</code>, <code>YANG</code>, <code>nil</code>;   default: <code>nil</code>;   See section <a href="#owner">owner</a></dt>

30267

<dt> mass   values: positive float number;   default: <code>1.0</code>;   access: read only</dt>

30268

</dl>

30269

30270

</dd>

30271

<dt> Messages: none</dt>

30272

<dt> Variants:</dt>

30273

<dd>

30274

30275

<dt> <img src="images/ac_marble_black.png" alt="images/ac_marble_black"> ac_marble: color = <code>BLACK</code>, controllers = <code>CTRL_YIN</code>, owner = <code>YIN</code>

30276

</dt>

30277

<dt> <img src="images/ac_marble_black.png" alt="images/ac_marble_black"> ac_marble_black: color = <code>BLACK</code>, controllers = <code>CTRL_YIN</code>, owner = <code>YIN</code>

30278

</dt>

30279

<dt> <img src="images/ac_marble_white.png" alt="images/ac_marble_white"> ac_marble_white: color = <code>WHITE</code>, controllers = <code>CTRL_YANG</code>, owner = <code>YANG</code>

30280

</dt>

30281

</dl>

30282

30283

</dd>

30284

</dl>

30285

30286

30287

30288

30289

30290

30291

30292

30293

30294

30295

30296

30297

30298

30299

30300

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

30301

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

30302

30303

</tr></table>

30304

30305

<h3 class="subsection">10.2.5 ac_pearl</h3>

30306

30307

30308

The main actor for meditation levels in the shape of a small ball, currently

30309

just in white color available. Pearls are like marbles versatile actors that

30310

can jump, pass <a href="#it_005fvortex">it_vortex</a>, but on the other hand they can sink, fall and

30311

shatter, too.

30312

30313

As long as the ‘<samp>owner</samp>’ has an <a href="#it_005fextralife">it_extralife</a> in his inventory a dying

30314

marble will be resurrected. If no extra life is available a dying actor ends

30315

up in the ‘<samp>state</samp>’ dead and can no longer be controlled.

30316

30317

The pearls are preset to their standard attribute values. The pearls state

30318

changes due to events and can be read only.

30319

30320

30321

<dt> Attributes:</dt>

30322

<dd>

30323

30324

<dt> state,   values: <code>ALIVE</code>, <code>DEAD</code>;   default: <code>ALIVE</code>;   See section <a href="#state">state</a>;   access: read only</dt>

30325

<dt> color   values: <code>BLACK</code>, <code>WHITE</code>;   default: <code>WHITE</code>;   access: read only</dt>

30326

<dd>The color of the pearl.

30327

</dd>

30328

<dt> adhesion   values: number;   default: <code>1.0</code>;   See section <a href="#adhesion">adhesion</a></dt>

30329

<dt> controllers   values: <code>CTRL_NONE</code>, <code>CTRL_YIN</code>, <code>CTRL_YANG</code>, <code>CTRL_YINYANG</code>;   default: <code>CTRL_NONE</code>;   See section <a href="#controllers">controllers</a></dt>

30330

<dt> owner   values: <code>YIN</code>, <code>YANG</code>, <code>nil</code>;   default: <code>nil</code>;   See section <a href="#owner">owner</a></dt>

30331

<dt> mass   values: positive float number;   default: <code>0.7</code>;   access: read only</dt>

30332

</dl>

30333

30334

</dd>

30335

<dt> Messages: none</dt>

30336

<dt> Variants:</dt>

30337

<dd>

30338

30339

<dt> <img src="images/ac_pearl_white.png" alt="images/ac_pearl_white"> ac_pearl: color = <code>WHITE</code>, controllers = <code>CTRL_YINYANG</code>, owner = <code>YIN</code>

30340

</dt>

30341

<dt> <img src="images/ac_pearl_black.png" alt="images/ac_pearl_black"> ac_pearl_black: color = <code>BLACK</code>, controllers = <code>CTRL_YINYANG</code>, owner = <code>YIN</code>

30342

</dt>

30343

<dt> <img src="images/ac_pearl_white.png" alt="images/ac_pearl_white"> ac_pearl_white: color = <code>WHITE</code>, controllers = <code>CTRL_YINYANG</code>, owner = <code>YIN</code>

30344

</dt>

30345

</dl>

30346

30347

</dd>

30348

</dl>

30349

30350

30351

30352

30353

30354

30355

30356

30357

30358

30359

30360

30361

30362

30363

30364

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

30365

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

30366

30367

</tr></table>

30368

30369

<h3 class="subsection">10.2.6 ac_rotor</h3>

30370

30371

30372

A rotating actor build up of 4 greenish cudgels. It is a death bringing actor

30373

that shatters <a href="#ac_005fmarble">ac_marble</a>s and <a href="#ac_005fpearl">ac_pearl</a>s on contact. Its behaviour

30374

is identical to an <a href="#ac_005ftop">ac_top</a>.

30375

30376

In contrast to the main actors it can not jump or pass an <a href="#it_005fvortex">it_vortex</a>, and

30377

will not sink, fall or shatter. A rotor is immortal.

30378

30379

Rotors do usually hunt mortal actors trying to shatter them. They accelerate by

30380

force given by the attribute ‘<samp>strength</samp>’, but they limit their hunt to

30381

actors in the given ‘<samp>range</samp>’. If no attackable actor remains in this range

30382

they return to their initial position if the attribute ‘<samp>gohome</samp>’ is

30383

‘<samp>true</samp>’.

30384

30385

Note that in case multiple attackable actors are in range the rotor gets

30386

confused and tries to attack the center of its victims. But if you set the

30387

attribute ‘<samp>attacknearest</samp>’ to ‘<samp>true</samp>’ the rotor will concentrate just

30388

on the nearest victim. By adjusting the attribute ‘<samp>prefercurrent</samp>’ you

30389

can instruct the rotors to prefer victims of the current active player with

30390

a certain likelihood.

30391

30392

Note that you need to set ‘<samp>controllers</samp>’ as well as ‘<samp>adhesion</samp>’ to proper

30393

values if you want a player to control a rotor directly. If a rotor is owned by a

30394

player <a href="#fl_005fthief">fl_thief</a> and <a href="#st_005fthief">st_thief</a> will steal items from it.

30395

30396

An <a href="#ac_005fmarble">ac_marble</a> will temporarily transform into a rotor when it activates

30397

an <a href="#it_005fdrop">it_drop</a>. During the 5 seconds of transformation the actor is a real

30398

immortal rotor with the identity inclusive the ‘<samp>essential_id</samp>’ of the

30399

former marble. After the period is over it transforms back to its original

30400

kind.

30401

30402

30403

<dt> Attributes:</dt>

30404

<dd>

30405

30406

<dt> range   values: float number;   default: <code>5.0</code></dt>

30407

<dd>The distance up to which victims are hunted.

30408

</dd>

30409

<dt> strength   values: float number;   default: <code>+10.0</code></dt>

30410

<dd>The force that drives the rotor to its victims.

30411

</dd>

30412

<dt> gohome   values: <code>true</code>, <code>false</code>;   default: <code>true</code></dt>

30413

<dd>Behaviour of a rotor without victim in range.

30414

</dd>

30415

<dt> attacknearest   values: <code>true</code>, <code>false</code>;   default: <code>true</code></dt>

30416

<dd>Behaviour of a rotor with multiple victims in range

30417

</dd>

30418

<dt> prefercurrent   values: float number in range [0.0 - 1.0];   default: <code>+0.0</code></dt>

30419

<dd>Likelihood of attack strategy. You will usually use this attribute in

30420

combination with ‘<samp>attacknearest</samp>’ set to ‘<samp>true</samp>’. The Level

30421

‘<samp>Toreador</samp>’ is an example of the behavior of such rotors.

30422

</dd>

30423

<dt> mass   values: positive float number;   default: <code>0.8</code>;   access: read only</dt>

30424

</dl>

30425

30426

</dd>

30427

<dt> Messages: none</dt>

30428

<dt> Variants:</dt>

30429

<dd>

30430

30431

<dt> <img src="images/ac_rotor.png" alt="images/ac_rotor"> ac_rotor: color = <code>nil</code>, controllers = <code>CTRL_NONE</code>, owner = <code>nil</code>

30432

</dt>

30433

</dl>

30434

30435

</dd>

30436

</dl>

30437

30438

30439

30440

30441

30442

30443

30444

30445

30446

30447

30448

30449

30450

30451

30452

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

30453

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

30454

30455

</tr></table>

30456

30457

30458

30459

30460

A fast rotating, greenish disk like actor. It is a death bringing actor

30461

that shatters <a href="#ac_005fmarble">ac_marble</a>s and <a href="#ac_005fpearl">ac_pearl</a>s on contact. Its behaviour

30462

is identical to an <a href="#ac_005frotor">ac_rotor</a>.

30463

30464

In contrast to the main actors it can not jump or pass an <a href="#it_005fvortex">it_vortex</a>, and

30465

will not sink, fall or shatter. A top is immortal.

30466

30467

Tops do usually hunt mortal actors trying to shatter them. They accelerate by

30468

force given by the attribute ‘<samp>strength</samp>’, but they limit their hunt to

30469

actors in the given ‘<samp>range</samp>’. If no attackable actor remains in this range

30470

they return to their initial position if the attribute ‘<samp>gohome</samp>’ is

30471

‘<samp>true</samp>’.

30472

30473

Note that in case multiple attackable actors are in range the top gets

30474

confused and tries to attack the center of its victims. But if you set the

30475

attribute ‘<samp>attacknearest</samp>’ to ‘<samp>true</samp>’ the top will concentrate just

30476

on the nearest victim. By adjusting the attribute ‘<samp>prefercurrent</samp>’ you

30477

can instruct the top to prefer victims of the current active player with

30478

a certain likelihood.

30479

30480

Note that you need to set ‘<samp>controllers</samp>’ as well as ‘<samp>adhesion</samp>’ to proper

30481

values if you want a player to control a top directly. If a top is owned by a

30482

player <a href="#fl_005fthief">fl_thief</a> and <a href="#st_005fthief">st_thief</a> will steal items from it.

30483

30484

30485

<dt> Attributes:</dt>

30486

<dd>

30487

30488

<dt> range   values: float number;   default: <code>5.0</code></dt>

30489

<dd>The distance up to which victims are hunted.

30490

</dd>

30491

<dt> strength   values: float number;   default: <code>+10.0</code></dt>

30492

<dd>The force that drives the top to its victims.

30493

</dd>

30494

<dt> gohome   values: <code>true</code>, <code>false</code>;   default: <code>true</code></dt>

30495

<dd>Behaviour of a top without victim in range.

30496

</dd>

30497

<dt> attacknearest   values: <code>true</code>, <code>false</code>;   default: <code>true</code></dt>

30498

<dd>Behaviour of a top with multiple victims in range

30499

</dd>

30500

<dt> prefercurrent   values: float number in range [0.0 - 1.0];   default: <code>+0.0</code></dt>

30501

<dd>Likelihood of attack strategy. You will usually use this attribute in

30502

combination with ‘<samp>attacknearest</samp>’ set to ‘<samp>true</samp>’. The Level

30503

‘<samp>Toreador</samp>’ is an example of the behavior of such rotors.

30504

</dd>

30505

<dt> mass   values: positive float number;   default: <code>0.8</code>;   access: read only</dt>

30506

</dl>

30507

30508

</dd>

30509

<dt> Messages: none</dt>

30510

<dt> Variants:</dt>

30511

<dd>

30512

30513

<dt> <img src="images/ac_top.png" alt="images/ac_top"> ac_top: color = <code>nil</code>, controllers = <code>CTRL_NONE</code>, owner = <code>nil</code>

30514

</dt>

30515

</dl>

30516

30517

</dd>

30518

</dl>

30519

30520

30521

30522

30523

30524

30525

30526

30527

30528

30529

30530

30531

30532

30533

30534

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

30535

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

30536

30537

</tr></table>

30538

30539

<h2 class="section">10.3 Actor Features</h2>

30540

30541

30542

<tr><td align="left" valign="top"><a href="#Flying-Actors">10.3.1 Flying Actors</a></td><td>  </td><td align="left" valign="top"></td></tr>

30543

</table>

30544

30545

30546

30547

30548

30549

30550

30551

30552

30553

30554

30555

30556

30557

30558

30559

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

30560

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

30561

30562

</tr></table>

30563

30564

<h3 class="subsection">10.3.1 Flying Actors</h3>

30565

30566

Ball like actors, namely <a href="#ac_005fmarble">ac_marble</a> and <a href="#ac_005fpearl">ac_pearl</a> are able to fly for

30567

short period of time if they get catapulted by some item.

30568

30569

Currently there are portable <a href="#it_005fspring">it_spring</a> that let actors jump on activation,

30570

static <a href="#it_005fspringboard">it_springboard</a> that catapult crossing actors and <a href="#it_005fvortex">it_vortex</a>

30571

that catapult warping actors.

30572

30573

A flying actor can pass lethal grids with <a href="#fl_005fwater">fl_water</a>, <a href="#fl_005fabyss">fl_abyss</a>,

30574

<a href="#it_005ftrap">it_trap</a> and even laser beams. But most stones will block flying actors,

30575

even some hollow ones like <a href="#st_005fgrate">st_grate</a> or <a href="#st_005foneway">st_oneway</a>. But some others as

30576

<a href="#st_005fdoor">st_door</a> or hollow <a href="#Standard-Stones">Standard Stones</a> let flying actors pass.

30577

30578

While flying an actor can not pick up any item. But the actor can still drop

30579

items. Activation of a spring while sinking in <a href="#fl_005fwater">fl_water</a> or <a href="#fl_005fswamp">fl_swamp</a>

30580

lets the actor jump immediately out of them and starts the sinking process from

30581

scratch anew when landing on such a floor.

30582

30583

30584

30585

30586

30587

30588

30589

30590

30591

30592

30593

30594

30595

30596

30597

30598

30599

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

30600

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

30601

30602

</tr></table>

30603

30604

<h1 class="chapter">11. Other Objects</h1>

30605

30606

30607

<tr><td align="left" valign="top"><a href="#Visible-Others">11.1 Visible Others</a></td><td>  </td><td align="left" valign="top"> Special gaming objects

30608

</td></tr>

30609

<tr><td align="left" valign="top"><a href="#Gadgets">11.2 Gadgets</a></td><td>  </td><td align="left" valign="top"> Tools for plug and play construction of levels

30610

</td></tr>

30611

</table>

30612

30613

30614

30615

30616

30617

30618

30619

30620

30621

30622

30623

30624

30625

30626

30627

30628

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

30629

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

30630

30631

</tr></table>

30632

30633

<h2 class="section">11.1 Visible Others</h2>

30634

30635

30636

<tr><td align="left" valign="top"><a href="#ot_005fcannonball">11.1.1 ot_cannonball</a></td><td>  </td><td align="left" valign="top"> Projectile of a Spitter

30637

</td></tr>

30638

<tr><td align="left" valign="top"><a href="#ot_005frubberband">11.1.2 ot_rubberband</a></td><td>  </td><td align="left" valign="top"> Rubberband with forces

30639

</td></tr>

30640

<tr><td align="left" valign="top"><a href="#ot_005fwire">11.1.3 ot_wire</a></td><td>  </td><td align="left" valign="top"> Stone connection that transfers impulses

30641

</td></tr>

30642

</table>

30643

30644

30645

30646

30647

30648

30649

30650

30651

30652

30653

30654

30655

30656

30657

30658

30659

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

30660

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

30661

30662

</tr></table>

30663

30664

<h3 class="subsection">11.1.1 ot_cannonball</h3>

30665

30666

30667

A short living projectile emitted by an <a href="#st_005fspitter">st_spitter</a>. It is an internal

30668

object that can not be directly instantiated. It is listed here just for

30669

completeness.

30670

30671

30672

30673

30674

30675

30676

30677

30678

30679

30680

30681

30682

30683

30684

30685

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

30686

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

30687

30688

</tr></table>

30689

30690

<h3 class="subsection">11.1.2 ot_rubberband</h3>

30691

30692

30693

An orange link between two objects that can apply attracting or repelling forces

30694

to them.

30695

30696

The two connected objects are called anchors. The attribute ‘<samp>anchor1</samp>’ holds

30697

the first object’s reference that must be an actor. The ‘<samp>anchor2</samp>’ references

30698

the second object that can either be another actor or a stone. Both objects

30699

must exist to <a href="#add">add</a> a rubberband to the world. If the stone sinks, breaks

30700

or is killed otherwise the rubberband will be destroyed, too.

30701

30702

Both anchor objects will update their attributes <a href="#rubbers">rubbers</a> and <a href="#fellows">fellows</a>

30703

to list this rubberband and the connected object for purposes of evaluation.

30704

30705

The force that is applied between the objects can be configured by several

30706

attributes. Every rubberband has a natural ‘<samp>length</samp>’ at which it does not

30707

apply any force to the actors. The more the rubberband is extended from this

30708

point it applies a force of the given ‘<samp>strength</samp>’. A positive strength is

30709

a natural attracting force, whereas a negative strength would repel the actors.

30710

30711

A rubberband that is shorter than its natural ‘<samp>length</samp>’ would normally not

30712

apply any force. But this special rubber allows you to set a ‘<samp>threshold</samp>’

30713

where the rubberband starts to apply the opposite directed forces onto the

30714

actors, like a spring would do. Thus a positive ‘<samp>strength</samp>’ would lead to a

30715

repelling force, a negative one to an attracting force. A rubberband with a

30716

length in between ‘<samp>threshold</samp>’ and ‘<samp>length</samp>’ will apply no forces.

30717

If you set the attribute ‘<samp>length</samp>’ to the value <code>AUTOLENGTH</code>, the

30718

length of the rubberband is determined from the distance of its two endpoints

30719

at the time of creation.

30720

30721

In some cases you do want to limit the length of the rubberband. You can do this

30722

by setting ‘<samp>min</samp>’ and ‘<samp>max</samp>’ attributes. Actors will bounce on these

30723

limits. Do not try to use artificial large ‘<samp>strength</samp>’ values instead to

30724

ensure length limits, as this could lead to extreme forces causing unexpected and

30725

unstable actor movements.

30726

30727

If you set ‘<samp>min</samp>’ or ‘<samp>max</samp>’ limits, extraordinary events like actor

30728

warping, actor resurrection, moving anchor stones or simply rubberbands that are

30729

created with an off limit length can cause trouble. When such a limit violation

30730

is detected an action is performed with a value ‘<samp>false</samp>’. You may want to kill

30731

the rubberband or react in another way by a callback function. The default

30732

handling is an application of a constant force to bring the actors back within

30733

the limits. This force value is given by <a href="#RubberViolationStrength">RubberViolationStrength</a> and

30734

defaults to ‘<samp>50.0</samp>’. If you really need to assure that the player is not able

30735

to violate the limits any further you may need to increase this constant.

30736

30737

Rubberbands can be cut by <a href="#st_005fscissors">st_scissors</a>, by an <a href="#it_005fvortex">it_vortex</a> or

30738

<a href="#it_005fwormhole">it_wormhole</a> with a set ‘<samp>scissors</samp>’ attribute, by receiving a

30739

<a href="#kill">kill</a> message, by one of the anchors receiving a <a href="#disconnect">disconnect</a> message

30740

or a stone anchor that ceases to exist.

30741

30742

Rubberbands can be dynamically generated by <a href="#it_005frubberband">it_rubberband</a> and

30743

<a href="#st_005frubberband">st_rubberband</a>.

30744

30745

30746

<dt> Attributes:</dt>

30747

<dd>

30748

30749

<dt> anchor1   values: actor object;   default: <code>nil</code></dt>

30750

<dd>Object reference or name of an actor that the rubber will be connected to. Note

30751

that the reference will be immediately evaluated and thus the actor must exist

30752

already.

30753

</dd>

30754

<dt> anchor2   values: actor or stone object;   default: <code>nil</code></dt>

30755

<dd>Object reference or name of an actor or a stone that the rubber will be

30756

connected to. Note that the reference will be immediately evaluated and thus the

30757

actor or stone must exist already.

30758

</dd>

30759

<dt> strength   values: number;   default: <code>10.0</code></dt>

30760

<dd>The force strength.

30761

</dd>

30762

<dt> length   values: positive number or <code>AUTOLENGTH</code>;   default: <code>1.0</code></dt>

30763

<dd>The natural length above which forces are applied.

30764

</dd>

30765

<dt> threshold   values: positive number or zero;   default: <code>0.0</code></dt>

30766

<dd>The length smaller than the natural length below which inverted forces are applied.

30767

</dd>

30768

<dt> min   values: positive number or zero;   default: <code>0.0</code></dt>

30769

<dd>The minimum length at which actors bounce.

30770

</dd>

30771

<dt> max   values: positive number or zero;   default: <code>0.0</code></dt>

30772

<dd>The maximum length at which actors bounce.

30773

</dd>

30774

</dl>

30775

30776

</dd>

30777

<dt> Messages: none</dt>

30778

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

30779

<dd>An action will be performed with value ‘<samp>false</samp>’ on violation of a min or max

30780

limit. Additionally an action will be performed on behalf of <a href="#it_005frubberband">it_rubberband</a>

30781

after application and creation of this rubberband with an action value of

30782

‘<samp>true</samp>’.

30783

</dd>

30784

</dl>

30785

30786

30787

30788

30789

30790

30791

30792

30793

30794

30795

30796

30797

30798

30799

30800

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

30801

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

30802

30803

</tr></table>

30804

30805

30806

30807

30808

A wire is a purple wire connecting two stones that transfers every stone pushing

30809

impulse from one stone to the other and vice versa. Thus both stones will move

30810

on the impulse if they are movable at all and not blocked in the direction of

30811

the impulse. The impulses may originate from an actor hitting a stone, an

30812

<a href="#it_005fpuller">it_puller</a>, an <a href="#st_005frotator">st_rotator</a>, an <a href="#st_005fstoneimpulse">st_stoneimpulse</a>.

30813

30814

A single stone can be wired to many other stones. All these <a href="#fellows">fellows</a> will

30815

move on an impulse. But the impulses will not be propagated to further stones

30816

that are wired themselves to any of the fellows. Just the direct wired stones

30817

will move.

30818

30819

But you can wire to stones just once. Any subsequent additional wire between

30820

two already wired stones will cut the old wire prior establishing the new one.

30821

30822

You can request the wires connected to a stone by the stones <a href="#wires">wires</a>

30823

attribute. As it is tedious to evaluate both anchors, every stone supports

30824

an attribute <a href="#fellows">fellows</a> that reports the connected objects.

30825

30826

30827

<dt> Attributes:</dt>

30828

<dd>

30829

30830

<dt> anchor1   values: stone object;   default: <code>nil</code></dt>

30831

<dd>Object reference or name of a stone that the wire will be connected to. Note

30832

that the reference will be immediately evaluated and thus the stone must exist

30833

already.

30834

</dd>

30835

<dt> anchor2   values: stone object;   default: <code>nil</code></dt>

30836

<dd>Object reference or name of a stone that the wire will be connected to. Note

30837

that the reference will be immediately evaluated and thus the stone must exist

30838

already.

30839

</dd>

30840

</dl>

30841

30842

</dd>

30843

<dt> Messages: none</dt>

30844

<dt> Actions: none</dt>

30845

</dl>

30846

30847

30848

30849

30850

30851

30852

30853

30854

30855

30856

30857

30858

30859

30860

30861

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

30862

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

30863

30864

</tr></table>

30865

30866

<h2 class="section">11.2 Gadgets</h2>

30867

30868

30869

30870

<tr><td align="left" valign="top"><a href="#ot_005fcounter">11.2.1 ot_counter</a></td><td>  </td><td align="left" valign="top"> Threshold Switch

30871

</td></tr>

30872

<tr><td align="left" valign="top"><a href="#ot_005ftimer">11.2.2 ot_timer</a></td><td>  </td><td align="left" valign="top"> Invisible Timer

30873

</td></tr>

30874

</table>

30875

30876

30877

30878

30879

30880

30881

30882

30883

30884

30885

30886

30887

30888

30889

30890

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

30891

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

30892

30893

</tr></table>

30894

30895

<h3 class="subsection">11.2.1 ot_counter</h3>

30896

30897

30898

A counter that switches on given thresholds. As a supplement to single switch

30899

like objects as <a href="#it_005ftrigger">it_trigger</a>, <a href="#st_005fswitch">st_switch</a>, <a href="#st_005flaserswitch">st_laserswitch</a>,

30900

<a href="#st_005fcoinslot">st_coinslot</a>, <a href="#st_005fkey">st_key</a>, <a href="#st_005ffloppy">st_floppy</a>, etc. this gadget allows to

30901

react on a given number of these switches to be switched ‘<samp>ON</samp>’ while the

30902

others being switched ‘<samp>OFF</samp>’.

30903

30904

The attribute ‘<samp>state</samp>’ represents the count of switches in ‘<samp>ON</samp>’ state.

30905

Due to the <a href="#Snapshot-Principle">Snapshot Principle</a> you need to set it to the initial number

30906

of ‘<samp>ON</samp>’ switches. All switches need to declare the counter gadget as their

30907

‘<samp>target</samp>’. They all need to send a <code>"signal"</code> message as ‘<samp>action</samp>’.

30908

The counter gadget increases or decreases its count state on every received

30909

signal message thus keeping it up to date.

30910

30911

The gadget itself can perform actions by usage of <a href="#Object-State">Object State</a> dependent

30912

targets and actions.

30913

30914

E.g. let us assume 8 <a href="#it_005ftrigger">it_trigger</a>s and 8 <a href="#st_005fbox">st_box</a>es. Two boxes are

30915

initially on top of two triggers. A door should open as soon as the user

30916

succeeds in pushing all boxes onto the triggers.

30917

30918

<table><tr><td> </td><td><pre class="example">ti["t"] = {"it_trigger", target="mycounter", action="signal"}

30919

ti["b"] = {"st_box"}

30920

ti["o"] = ti["t"] .. ti["b"]

30921

ti["d"] = {"st_door", "mydoor"}

30922

wo(ti, " ", {"t t t o t o t t",

30923

"b b b b b b",

30924

" d @ "})

30925

wo:add({"ot_counter", "mycounter", state=2, target="mydoor", action_7="close", action_8="open"})

30926

</pre></td></tr></table>

30927

30928

Note that it is not sufficient to send an <code>"open"</code> message on a

30929

‘<samp>state</samp>’ count of 8, as this event occurs, when 7 boxes are on top of

30930

triggers and the last trigger is pressed by the actor itself, too. When the

30931

actor leaves the 8th trigger the gadget state decreases its state to 7 and

30932

sends a <code>"close"</code> message to the door.

30933

30934

30935

<dt> Attributes:</dt>

30936

<dd>

30937

30938

<dt> state,   values: numbers;   default: 0   See section <a href="#state">state</a></dt>

30939

<dd>The count of switches in ‘<samp>ON</samp>’ state.

30940

</dd>

30941

</dl>

30942

30943

</dd>

30944

<dt> Messages:</dt>

30945

<dd>

30946

30947

<dt> signal   See section <a href="#signal">signal</a></dt>

30948

<dd>Increases state on a value of ‘<samp>1</samp>’, and decreases on a value of ‘<samp>0</samp>’.

30949

</dd>

30950

</dl>

30951

30952

</dd>

30953

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

30954

<dd>Sends an action with value ‘<samp>true</samp>’ just on explicitly given

30955

<a href="#Object-State">Object State</a> dependent target or action attributes. No default

30956

<code>"toggle"</code> actions will be issued on other states.

30957

</dd>

30958

</dl>

30959

30960

30961

30962

30963

30964

30965

30966

30967

30968

30969

30970

30971

30972

30973

30974

30975

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

30976

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

30977

30978

</tr></table>

30979

30980

<h3 class="subsection">11.2.2 ot_timer</h3>

30981

30982

30983

This gadget can be used to trigger a delayed single or periodic events. It is

30984

nearly identical to the <a href="#st_005ftimer">st_timer</a>, but does neither require a grid position

30985

nor disturb the user by a pulsing animation.

30986

30987

Note that this is an exceptional object as its default state is ‘<samp>ON</samp>’ to

30988

support the most common case of immediately running timers.

30989

30990

A single shot, not looping timer will send an action value of ‘<samp>true</samp>’. A

30991

looping timer will alternate the boolean action values starting with value

30992

‘<samp>true</samp>’. You can use <a href="#inverse">inverse</a> to start with a value of ‘<samp>false</samp>’.

30993

30994

If you stop a timer by switching it off, no further events will be performed.

30995

Restarting the timer by switching it on again will restart the timer like

30996

a new timer.

30997

30998

The time interval to the first event and between subsequent events can be relied

30999

on to an accuracy of 0.01 seconds. But due to performance reasons and visibility

31000

of the reactions timers should not be set to intervals below 0.1 seconds. An

31001

interval of less than 0.01 seconds is not valid for a looping timer.

31002

31003

31004

<dt> Attributes:</dt>

31005

<dd>

31006

31007

<dt> state,   values: <code>ON</code>, <code>OFF</code>;   default: <code>ON</code>   See section <a href="#state">state</a></dt>

31008

<dd>An ‘<samp>ON</samp>’ state timer is running. A timer in state ‘<samp>OFF</samp>’ is reset and

31009

waiting for reactivation.

31010

</dd>

31011

<dt> interval   values: positive number;   default: <code>1.0</code></dt>

31012

<dd>Number of seconds until the first and between subsequent events. The interval

31013

must be larger or equal 0.01 seconds for looping timers.

31014

</dd>

31015

<dt> loop   values: <code>true</code>, <code>false</code>;   default: <code>true</code></dt>

31016

<dd>A looping timer will send periodic events.

31017

</dd>

31018

</dl>

31019

31020

</dd>

31021

<dt> Messages:</dt>

31022

<dd>

31023

31024

<dt> signal   See section <a href="#signal">signal</a></dt>

31025

<dd>Switches on at value ‘<samp>1</samp>’, and off at values ‘<samp>0</samp>’.

31026

</dd>

31027

<dt> on   See section <a href="#on">on</a></dt>

31028

<dt> off   See section <a href="#off">off</a></dt>

31029

</dl>

31030

31031

</dd>

31032

<dt> Action:   See section <a href="#target">target</a>,   See section <a href="#action">action</a></dt>

31033

<dd>The action value starts with ‘<samp>true</samp>’ and alternates on every event between

31034

‘<samp>false</samp>’ and ‘<samp>true</samp>’. A timer that is reset starts again with value

31035

‘<samp>true</samp>’

31036

</dd>

31037

</dl>

31038

31039

31040

31041

31042

31043

31044

31045

31046

31047

31048

31049

31050

31051

31052

31053

31054

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

31055

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

31056

31057

</tr></table>

31058

31059

<h1 class="chapter">12. Libraries</h1>

31060

31061

Libraries do contain extensions that are not necessary for every level. By

31062

outsourcing them into separate files they do not get loaded if not used. This

31063

improves the level load time and runtime resource consumption. But as a level

31064

author you have to declare the usage of a library by an XML metadata

31065

‘<samp>dependency</samp>’ element within the <a href="#g_t_003ccompatibility_003e"><compatibility></a> element. The

31066

necessary line of code is listed within every library description.

31067

31068

Some libraries contain collections of useful functions and methods. They are

31069

described in this chapter. Other libraries do contain <a href="#Resolvers">Resolvers</a> and are

31070

described just there.

31071

31072

31073

<tr><td align="left" valign="top"><a href="#Basic-Functions">12.1 Basic Functions</a></td><td>  </td><td align="left" valign="top"> About basic lua functions and standard lua libraries.

31074

</td></tr>

31075

<tr><td align="left" valign="top"><a href="#liblua">12.2 liblua</a></td><td>  </td><td align="left" valign="top"> General methods for tables.

31076

</td></tr>

31077

<tr><td align="left" valign="top"><a href="#libmath">12.3 libmath</a></td><td>  </td><td align="left" valign="top"> Mathematical algorithms, like random permutations.

31078

</td></tr>

31079

<tr><td align="left" valign="top"><a href="#libmap">12.4 libmap</a></td><td>  </td><td align="left" valign="top"> Methods for API 2-maps.

31080

</td></tr>

31081

<tr><td align="left" valign="top"><a href="#libimport">12.5 libimport</a></td><td>  </td><td align="left" valign="top"> Methods for importing external level files.

31082

</td></tr>

31083

<tr><td align="left" valign="top"><a href="#libsoko">12.6 libsoko</a></td><td>  </td><td align="left" valign="top"> A library to interpret Sokoban level files.

31084

</td></tr>

31085

</table>

31086

31087

31088

31089

31090

31091

31092

31093

31094

31095

31096

31097

31098

31099

31100

31101

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

31102

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

31103

31104

</tr></table>

31105

31106

<h2 class="section">12.1 Basic Functions</h2>

31107

31108

Enigma supports most Lua 5.1 and above statements, i.e. you can freely use

31109

tables and control structures in your level, as you would expect. However, some

31110

Lua functions have been deactivated for security reasons or to ensure

31111

upwards compatibility. These are ‘<samp>dofile</samp>’, ‘<samp>module</samp>’, ‘<samp>require</samp>’

31112

and most or all functions of the standard libraries ‘<samp>package</samp>’, ‘<samp>io</samp>’

31113

and ‘<samp>os</samp>’. You should use the <a href="#g_t_003ccompatibility_003e"><compatibility></a>-tag to include external

31114

libraries instead of ‘<samp>require</samp>’, ‘<samp>dofile</samp>’ or ‘<samp>package</samp>’, and

31115

‘<samp>print</samp>’ for output to stdout instead of ‘<samp>io</samp>’. The ‘<samp>print</samp>’

31116

function is pretty useful for developing and debugging complex levels, but

31117

should not appear in the level’s final version anymore.

31118

31119

Of Lua’s built-in mathematical functions you may use any of the following:

31120

‘<samp>math.abs</samp>’, ‘<samp>math.acos</samp>’, ‘<samp>math.asin</samp>’, ‘<samp>math.atan</samp>’,

31121

‘<samp>math.atan2</samp>’, ‘<samp>math.ceil</samp>’, ‘<samp>math.cos</samp>’, ‘<samp>math.cosh</samp>’,

31122

‘<samp>math.deg</samp>’, ‘<samp>math.exp</samp>’, ‘<samp>math.floor</samp>’, ‘<samp>math.fmod</samp>’,

31123

‘<samp>math.frexp</samp>’, ‘<samp>math.huge</samp>’, ‘<samp>math.ldexp</samp>’, ‘<samp>math.log</samp>’,

31124

‘<samp>math.log10</samp>’, ‘<samp>math.max</samp>’, ‘<samp>math.min</samp>’, ‘<samp>math.modf</samp>’,

31125

‘<samp>math.pi</samp>’, ‘<samp>math.pow</samp>’, ‘<samp>math.rad</samp>’, ‘<samp>math.random</samp>’,

31126

‘<samp>math.sin</samp>’, ‘<samp>math.sinh</samp>’, ‘<samp>math.sqrt</samp>’, ‘<samp>math.tan</samp>’,

31127

‘<samp>math.tanh</samp>’.

31128

31129

All trigonometric functions use radians, you can use ‘<samp>math.deg</samp>’ and

31130

‘<samp>math.rad</samp>’ to convert between radians and degrees. For the differences

31131

between ‘<samp>math.mod</samp>’, ‘<samp>%</samp>’, and ‘<samp>math.fmod</samp>’ see <a href="#lib_002elua_002emod">lib.lua.mod</a>.

31132

31133

While you have access to nearly all mathematical functions Lua defines, Enigma

31134

uses an own random generator, which you access via ‘<samp>math.random</samp>’ with the

31135

same syntax as Lua’s random generator. To ensure stability in future versions

31136

of Enigma, ‘<samp>math.randomseed</samp>’ is disabled.

31137

31138

Please read the online manual of

31139

<a href="http://www.lua.org/manual/5.1/">Lua 5.1</a> for more detailed information.

31140

31141

31142

31143

31144

31145

31146

31147

31148

31149

31150

31151

31152

31153

31154

31155

31156

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

31157

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

31158

31159

</tr></table>

31160

31161

<h2 class="section">12.2 liblua</h2>

31162

31163

This library of basic extensions to the Lua language is described as of release

31164

1.

31165

31166

You can load it by adding an ‘<samp>dependency</samp>’ element to the

31167

<a href="#g_t_003ccompatibility_003e"><compatibility></a> XML Metadata element as follows:

31168

31169

<table><tr><td> </td><td><pre class="example"> <el:dependency el:path="<var>lib/liblua</var>" el:id="<var>lib/liblua</var>" el:release="<var>1</var>" el:preload="<var>true</var>"/>

31170

</pre></td></tr></table>

31171

31172

31173

<tr><td align="left" valign="top"><a href="#lib_002elua_002ecombine_005ftables">12.2.1 lib.lua.combine_tables</a></td><td>  </td><td align="left" valign="top"> Collect entries of anonymous Lua-tables into a common table.

31174

</td></tr>

31175

<tr><td align="left" valign="top"><a href="#lib_002elua_002edeep_005fcopy">12.2.2 lib.lua.deep_copy</a></td><td>  </td><td align="left" valign="top"> Complete copies of Lua-tables.

31176

</td></tr>

31177

<tr><td align="left" valign="top"><a href="#lib_002elua_002emod">12.2.3 lib.lua.mod</a></td><td>  </td><td align="left" valign="top"> A modulo operation.

31178

</td></tr>

31179

<tr><td align="left" valign="top"><a href="#lib_002elua_002eprint_005ftable">12.2.4 lib.lua.print_table</a></td><td>  </td><td align="left" valign="top"> Print tables for debug reasons.

31180

</td></tr>

31181

<tr><td align="left" valign="top"><a href="#lib_002elua_002eshuffle">12.2.5 lib.lua.shuffle</a></td><td>  </td><td align="left" valign="top"> Shuffle arbitrary anonymous Lua-tables.

31182

</td></tr>

31183

<tr><td align="left" valign="top"><a href="#lib_002elua_002eto_005fstring">12.2.6 lib.lua.to_string</a></td><td>  </td><td align="left" valign="top"> Takes anything as argument and tries to return a sensible description.

31184

</td></tr>

31185

</table>

31186

31187

31188

31189

31190

31191

31192

31193

31194

31195

31196

31197

31198

31199

31200

31201

31202

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

31203

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

31204

31205

</tr></table>

31206

31207

<h3 class="subsection">12.2.1 lib.lua.combine_tables</h3>

31208

31209

31210

‘<samp>combine_tables</samp>’ combines all entries of a set or table of tables into one

31211

common table (i.e., it joins the subtables). As some of the subtables can have

31212

equally named entries, the first subtable has highest priority, the second

31213

subtable second priority etc.

31214

31215

31216

<dt> Syntax:</dt>

31217

<dd>lib.lua.combine_tables(overtable)

31218

31219

lib.lua.combine_tables(table1, table2, ...)

31220

31221

31222

<dt> overtable</dt>

31223

<dd>A table of tables: ‘<samp>overtable = {table1, table2, ...}</samp>’

31224

31225

</dd>

31226

<dt> table1, table2, ...</dt>

31227

<dd>Lua tables to be joined.

31228

</dd>

31229

</dl>

31230

31231

</dd>

31232

<dt> Syntax Samples:</dt>

31233

<dd><table><tr><td> </td><td><pre class="example">all_contacts = lib.lua.combine_tables(telephone_numbers, email_addresses)

31234

</pre></td></tr></table>

31235

31236

</dd>

31237

<dt> Details:</dt>

31238

<dd>Just as groups can be joined by ‘<samp>grp1 + grp2</samp>’, it can sometimes be

31239

necessary to join anonymous tables, as well.

31240

In most situations, object grouping should be used instead, but when one works

31241

with more abstract data (like names of objects instead of objects, or tables

31242

holding design information), ‘<samp>combine_tables</samp>’ can be useful.

31243

31244

</dd>

31245

<dt> Full Example:</dt>

31246

</dl>

31247

31248

31249

31250

31251

31252

31253

31254

31255

31256

31257

31258

31259

31260

31261

31262

31263

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

31264

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

31265

31266

</tr></table>

31267

31268

31269

31270

31271

‘<samp>deep_copy</samp>’ returns a copy of its argument, where table entries are

31272

not copied as memory references (like Lua typically does), but complete

31273

(thereby called "deep copy").

31274

31275

31276

<dt> Syntax:</dt>

31277

<dd>lib.lua.deep_copy(source)

31278

31279

31280

<dt> source</dt>

31281

<dd>The object to be copied.

31282

</dd>

31283

</dl>

31284

31285

</dd>

31286

<dt> Syntax Samples:</dt>

31287

<dd><table><tr><td> </td><td><pre class="example">a = {5}

31288

b = a

31289

c = lib.lua.deep_copy(a)

31290

b[1] = 4

31291

</pre></td></tr></table>

31292

31293

After these four commands, ‘<samp>a[1]</samp>’ and ‘<samp>b[1]</samp>’ will both be ‘<samp>4</samp>’,

31294

but ‘<samp>c[1]</samp>’ will still be ‘<samp>5</samp>’.

31295

31296

</dd>

31297

<dt> Details:</dt>

31298

<dd>Metatables are transferred, but not deep-copied.

31299

Userdata (like tiles and positions) is not guaranteed to be deep-copied.

31300

31301

</dd>

31302

<dt> Full Example:</dt>

31303

</dl>

31304

31305

31306

31307

31308

31309

31310

31311

31312

31313

31314

31315

31316

31317

31318

31319

31320

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

31321

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

31322

31323

</tr></table>

31324

31325

31326

31327

31328

A wrapper for the modulo operation.

31329

31330

31331

<dt> Syntax:</dt>

31332

<dd>lib.lua.mod(value, modul)

31333

31334

31335

<dt> value, modul</dt>

31336

<dd>Numbers. ‘<samp>modul</samp>’ must be positive (non-zero).

31337

</dd>

31338

</dl>

31339

31340

</dd>

31341

<dt> Syntax Samples:</dt>

31342

<dd><table><tr><td> </td><td><pre class="example">lib.lua.mod(7*7, 17)

31343

lib.lua.mod(5.3, 1/3)

31344

lib.lua.mod(no["marble"].x, 1)

31345

</pre></td></tr></table>

31346

31347

</dd>

31348

<dt> Details:</dt>

31349

<dd>Lua 5.0 used ‘<samp>math.mod</samp>’ as modulo operation, this function is not

31350

available in Lua 5.1 anymore, and hence not available in Enigma. Lua 5.1

31351

provides ‘<samp>%</samp>’ and ‘<samp>math.fmod</samp>’. Whereas all three operations agree on

31352

positive numbers and zero as ‘<samp>value</samp>’, there are differences on negative

31353

numbers:

31354

<table><tr><td> </td><td><pre class="example">Lua 5.0: math.mod(-1, 4) == -1

31355

Lua 5.1: math.fmod(-1, 4) == -1

31356

Lua 5.1: (-1)%4 == 3

31357

lib.lua: lib.lua.mod(-1, 4) == 3

31358

</pre></td></tr></table>

31359

While the Lua-own modulo functions yield results even for negative

31360

‘<samp>modul</samp>’ (with varying signs of the outcome), ‘<samp>lib.lua.mod</samp>’ will raise

31361

an error if ‘<samp>modul <= 0</samp>’, and the result ‘<samp>r</samp>’ is otherwise guaranteed

31362

to be <code>0 <= r < modul</code>.

31363

31364

</dd>

31365

<dt> Full Example:</dt>

31366

</dl>

31367

31368

31369

31370

31371

31372

31373

31374

31375

31376

31377

31378

31379

31380

31381

31382

31383

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

31384

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

31385

31386

</tr></table>

31387

31388

<h3 class="subsection">12.2.4 lib.lua.print_table</h3>

31389

31390

31391

‘<samp>print_table</samp>’ is a debug command, which uses the API’s ‘<samp>print</samp>’

31392

command to recursively print its argument to the standard output.

31393

31394

31395

<dt> Syntax:</dt>

31396

<dd>lib.lua.print_table(table, prefix, depth)

31397

31398

31399

<dt> table</dt>

31400

<dd>The table to be printed.

31401

31402

</dd>

31403

<dt> prefix</dt>

31404

<dd>A string which will be printed before the table as a

31405

separator. Can be ‘<samp>nil</samp>’.

31406

31407

</dd>

31408

<dt> depth</dt>

31409

<dd>‘<samp>nil</samp>’ in normal use, ‘<samp>-1</samp>’ if you want to suppress the recursion.

31410

</dd>

31411

</dl>

31412

31413

</dd>

31414

<dt> Syntax Samples:</dt>

31415

<dd><table><tr><td> </td><td><pre class="example">a = {1, [5]=2, "Hello", other_table = {x = 4, y = 5, z = "World"}}

31416

lib.lua.print_table(a, nil, -1)

31417

lib.lua.print_table(a, "--> ")

31418

</pre></td></tr></table>

31419

31420

</dd>

31421

<dt> Details:</dt>

31422

<dd>‘<samp>print_table</samp>’ is recursive, i.e. a table with table

31423

as entries will call ‘<samp>print_table</samp>’ again. To avoid

31424

infinite loops, ‘<samp>depth</samp>’ is used internally to count

31425

the depth level of the recursion. The recursion currently

31426

stops on depth 5. Set ‘<samp>depth</samp>’ to ‘<samp>-1</samp>’ to stop

31427

recursion entirely.

31428

31429

Use ‘<samp>print_table</samp>’ only for debugging and testing, it

31430

is not meant as an element of gameplay.

31431

</dd>

31432

<dt> Full Example:</dt>

31433

</dl>

31434

31435

31436

31437

31438

31439

31440

31441

31442

31443

31444

31445

31446

31447

31448

31449

31450

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

31451

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

31452

31453

</tr></table>

31454

31455

<h3 class="subsection">12.2.5 lib.lua.shuffle</h3>

31456

31457

31458

‘<samp>shuffle</samp>’ randomly resorts its argument, a numerical table.

31459

31460

31461

<dt> Syntax:</dt>

31462

<dd>result = lib.lua.shuffle(source)

31463

31464

31465

<dt> source</dt>

31466

<dd>The table to be shuffled (only the numerical entries will be shuffled).

31467

</dd>

31468

</dl>

31469

31470

</dd>

31471

<dt> Syntax Samples:</dt>

31472

<dd><table><tr><td> </td><td><pre class="example">orientations = lib.lua.shuffle({NORTH, SOUTH, EAST, WEST})

31473

a = {1, 2, 3, "r", {"x", "y", "z"}, 4}

31474

b = lib.lua.shuffle(a)

31475

</pre></td></tr></table>

31476

31477

A typical result for ‘<samp>b</samp>’ would be

31478

<table><tr><td> </td><td><pre class="example">b = {"r", 4, 2, {"x", "y", "z"}, 1, 3}

31479

</pre></td></tr></table>

31480

31481

</dd>

31482

<dt> Details:</dt>

31483

<dd>The result is a permutation of the numerical entries of the source table,

31484

starting with entry 1 and ending with entry ‘<samp>table.getn(source)</samp>’. All

31485

other entries will simply be copied into ‘<samp>result</samp>’. All copies are shallow

31486

copies, i.e. table-valued and userdata-valued entries (like objects) are not

31487

copied, just references (pointers) to them. Use <a href="#lib_002elua_002edeep_005fcopy">lib.lua.deep_copy</a> to

31488

create a deep copy of the shuffled table, if needed. ‘<samp>result</samp>’ will use the

31489

same metatable as ‘<samp>source</samp>’, and metamethods will be used during the copy

31490

and shuffling process.

31491

31492

Currently, ‘<samp>lib.lua.shuffle</samp>’ can shuffle only tables. To shuffle groups,

31493

use the group method of the same name:

31494

<table><tr><td> </td><td><pre class="example">mygroup:shuffle()

31495

</pre></td></tr></table>

31496

31497

Shuffling a <a href="#libmap">libmap</a>-map results in a map with shuffled rows, i.e. the

31498

x-coordinates of all tile keys are kept constant. Use <a href="#Rotating-and-Mirroring-Maps">Rotating and Mirroring Maps</a> to shuffle the columns.

31499

31500

</dd>

31501

<dt> Full Example:</dt>

31502

</dl>

31503

31504

31505

31506

31507

31508

31509

31510

31511

31512

31513

31514

31515

31516

31517

31518

31519

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

31520

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

31521

31522

</tr></table>

31523

31524

<h3 class="subsection">12.2.6 lib.lua.to_string</h3>

31525

31526

31527

‘<samp>to_string</samp>’ is a debug function. It may take anything as argument, and

31528

tries to return a sensible string describing the type and, if possible, the

31529

content of the argument.

31530

31531

31532

<dt> Syntax:</dt>

31533

<dd>lib.lua.to_string(arg)

31534

31535

31536

31537

<dd>The argument to be described.

31538

</dd>

31539

</dl>

31540

31541

</dd>

31542

<dt> Syntax Samples:</dt>

31543

<dd><table><tr><td> </td><td><pre class="example">print(lib.lua.to_string(strange_variable))

31544

</pre></td></tr></table>

31545

31546

</dd>

31547

<dt> Details:</dt>

31548

<dd>‘<samp>to_string</samp>’ is meant for debugging Lua code. Sometimes it happens that a

31549

variable is not what the author expected to be, and selecting the correct

31550

output method becomes try-and-error. ‘<samp>to_string</samp>’ is a fast shortcut to

31551

this. It returns the content of strings, numbers, booleans, tables, positions,

31552

and groups. It distinguishes ordinary tables from <a href="#libmap">libmap</a>-maps. For

31553

objects, it returns their name and position, for position lists, it returns the

31554

total number of positions. It further recognizes nil, tile and tiles.

31555

31556

Use ‘<samp>to_string</samp>’ only for debugging and testing, it

31557

is not meant as an element of gameplay.

31558

31559

</dd>

31560

<dt> Full Example:</dt>

31561

</dl>

31562

31563

31564

31565

31566

31567

31568

31569

31570

31571

31572

31573

31574

31575

31576

31577

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

31578

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

31579

31580

</tr></table>

31581

31582

<h2 class="section">12.3 libmath</h2>

31583

31584

This library of basic mathematical extensions is described as of release 1.

31585

31586

You can load it by adding an ‘<samp>dependency</samp>’ element to the

31587

<a href="#g_t_003ccompatibility_003e"><compatibility></a> XML Metadata element as follows:

31588

31589

<table><tr><td> </td><td><pre class="example"> <el:dependency el:path="<var>lib/libmath</var>" el:id="<var>lib/libmath</var>" el:release="<var>1</var>" el:preload="<var>true</var>"/>

31590

</pre></td></tr></table>

31591

31592

It preloads automatically the library <a href="#liblua">liblua</a>.

31593

31594

31595

<tr><td align="left" valign="top"><a href="#lib_002emath_002ecombinations">12.3.1 lib.math.combinations</a></td><td>  </td><td align="left" valign="top"> Calculates all possible combinations of a set.

31596

</td></tr>

31597

<tr><td align="left" valign="top"><a href="#lib_002emath_002ecubic_005fpolynomial">12.3.2 lib.math.cubic_polynomial</a></td><td>  </td><td align="left" valign="top"> Calculates the result of a cubic polynomial.

31598

</td></tr>

31599

<tr><td align="left" valign="top"><a href="#lib_002emath_002ecyclic_005fpermutation">12.3.3 lib.math.cyclic_permutation</a></td><td>  </td><td align="left" valign="top"> Random cyclic permutation.

31600

</td></tr>

31601

<tr><td align="left" valign="top"><a href="#lib_002emath_002edigits">12.3.4 lib.math.digits</a></td><td>  </td><td align="left" valign="top"> Decomposes a number into digits for an arbitrary base.

31602

</td></tr>

31603

<tr><td align="left" valign="top"><a href="#lib_002emath_002emanhattan_005fdistance">12.3.5 lib.math.manhattan_distance</a></td><td>  </td><td align="left" valign="top"> Calculates the Manhattan distance of positions.

31604

</td></tr>

31605

<tr><td align="left" valign="top"><a href="#lib_002emath_002emark_005fcomponents">12.3.6 lib.math.mark_components</a></td><td>  </td><td align="left" valign="top"> Calculate connected components of a group of floors.

31606

</td></tr>

31607

<tr><td align="left" valign="top"><a href="#lib_002emath_002epermutation">12.3.7 lib.math.permutation</a></td><td>  </td><td align="left" valign="top"> Random permutation.

31608

</td></tr>

31609

<tr><td align="left" valign="top"><a href="#lib_002emath_002erandom_005fvector">12.3.8 lib.math.random_vector</a></td><td>  </td><td align="left" valign="top"> A table with random entries.

31610

</td></tr>

31611

<tr><td align="left" valign="top"><a href="#lib_002emath_002esteps">12.3.9 lib.math.steps</a></td><td>  </td><td align="left" valign="top"> A function to classify a number in intervals.

31612

</td></tr>

31613

</table>

31614

31615

31616

31617

31618

31619

31620

31621

31622

31623

31624

31625

31626

31627

31628

31629

31630

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

31631

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

31632

31633

</tr></table>

31634

31635

<h3 class="subsection">12.3.1 lib.math.combinations</h3>

31636

31637

31638

‘<samp>lib.math.combinations</samp>’ returns a table of all combinations of

31639

‘<samp>depth</samp>’ entries, each of which is chosen from ‘<samp>digits</samp>’.

31640

31641

31642

<dt> Syntax:</dt>

31643

<dd>lib.math.combinations(depth, digits)

31644

31645

31646

<dt> depth</dt>

31647

<dd>A positive integer.

31648

31649

</dd>

31650

<dt> digits</dt>

31651

<dd>A positive integer or a table with numerical entries.

31652

</dd>

31653

</dl>

31654

31655

</dd>

31656

<dt> Syntax Samples:</dt>

31657

<dd><table><tr><td> </td><td><pre class="example">lib.math.combinations(2, 2)

31658

== { {1, 1}, {1, 2}, {2, 1}, {2, 2} }

31659

lib.math.combinations(3, {7, 8, "a"})

31660

== { {7,7,7}, {7,7,8}, {7,7,"a"},

31661

{7,8,7}, {7,8,8}, {7,8,"a"},

31662

{7,"a",7}, {7,"a",8}, {7,"a","a"},

31663

{8,7,7}, ... }

31664

</pre></td></tr></table>

31665

31666

</dd>

31667

<dt> Details:</dt>

31668

<dd>Mathematically, it builds the leafs of an ‘<samp>#digits</samp>’-ary tree

31669

of depth ‘<samp>depth</samp>’.

31670

31671

</dd>

31672

<dt> Full Example:</dt>

31673

</dl>

31674

31675

31676

31677

31678

31679

31680

31681

31682

31683

31684

31685

31686

31687

31688

31689

31690

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

31691

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

31692

31693

</tr></table>

31694

31695

<h3 class="subsection">12.3.2 lib.math.cubic_polynomial</h3>

31696

31697

31698

‘<samp>cubic_polynomial</samp>’ returns the result of the following polynomial with

31699

coefficients in ‘<samp>a</samp>’:

31700

<table><tr><td> </td><td><pre class="example">a[10]*y*y*y + a[9]*x*y*y + a[8]*x*x*y + a[7]*x*x*x

31701

+ a[6]*y*y + a[5]*x*y + a[4]*x*x + a[3]*y + a[2]*x + a[1]

31702

</pre></td></tr></table>

31703

31704

31705

<dt> Syntax:</dt>

31706

<dd>lib.math.cubic_polynomial(a, x, y)

31707

31708

31709

31710

<dd>A table with numerical entries ‘<samp>a[1]</samp>’ to ‘<samp>a[10]</samp>’. The entries may be

31711

‘<samp>nil</samp>’ (i.e. missing), then they are interpreted as zero.

31712

31713

</dd>

31714

31715

<dd>Numbers.

31716

31717

</dd>

31718

</dl>

31719

31720

</dd>

31721

<dt> Syntax Samples:</dt>

31722

<dd><table><tr><td> </td><td><pre class="example">lib.math.cubic_polynomial({1, a, b}, x, y) == a*x + b*y + 1

31723

</pre></td></tr></table>

31724

31725

</dd>

31726

<dt> Details:</dt>

31727

<dd>You can use ‘<samp>lib.math.random_vector(10, ...)</samp>’ and a modulo operation to

31728

easily form a random pattern of a floor, or choose the coefficients to your own

31729

liking. Entries in ‘<samp>a</samp>’ which are not numbers are considered zero.

31730

31731

</dd>

31732

<dt> Full Example:</dt>

31733

<dd>This is an excerpt from "Weirdly Wired" and demonstrates the use of

31734

‘<samp>cubic_polynomial</samp>’ inside a custom resolver to create random, but

31735

patternlike floors:

31736

<table><tr><td> </td><td><pre class="example">[...]

31737

floors = {ti[" "], ti["a"], ti["b"], ti["c"]}

31738

polynom = lib.math.random_vector(10, 4)

31739

31740

function myresolver(key, x, y)

31741

if key == " " then

31742

return floors[lib.math.cubic_polynomial(a, x, y) % (#floors) + 1]

31743

elseif

31744

[...]

31745

else

31746

return ti[key]

31747

end

31748

end

31749

31750

w, h = wo(myresolver, " ", {

31751

[...]

31752

</pre></td></tr></table>

31753

"Weirdly Wired" is explained in detail in section <a href="#Weirdly-Wired">Weirdly Wired</a>.

31754

</dd>

31755

</dl>

31756

31757

31758

31759

31760

31761

31762

31763

31764

31765

31766

31767

31768

31769

31770

31771

31772

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

31773

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

31774

31775

</tr></table>

31776

31777

<h3 class="subsection">12.3.3 lib.math.cyclic_permutation</h3>

31778

31779

31780

‘<samp>cyclic_permutation</samp>’ returns a random permutation (i.e. a random shuffling)

31781

of the numbers 1 to ‘<samp>n</samp>’, which is cyclic: There exists a closed path from

31782

any number to any other number (see details below).

31783

31784

31785

<dt> Syntax:</dt>

31786

<dd>lib.math.cyclic_permutation(n)

31787

31788

31789

31790

<dd>A positive integer.

31791

</dd>

31792

</dl>

31793

31794

</dd>

31795

<dt> Syntax Samples:</dt>

31796

<dd><table><tr><td> </td><td><pre class="example">lib.math.cyclic_permutation(#no["marbles#*"])

31797

</pre></td></tr></table>

31798

31799

</dd>

31800

<dt> Details:</dt>

31801

<dd>A cyclic permutation is a special kind of permutation, which has only one

31802

cycle. The easiest way is to give an example for a cyclic permutation:

31803

<table><tr><td> </td><td><pre class="example">8, 1, 2, 9, 3, 7, 4, 6, 10, 5

31804

</pre></td></tr></table>

31805

We may write this as:

31806

<table><tr><td> </td><td><pre class="example">1 -> 8

31807

2 -> 1

31808

3 -> 2

31809

...

31810

</pre></td></tr></table>

31811

We can now put all of these together into a sequence:

31812

<table><tr><td> </td><td><pre class="example">1 -> 8 -> 6 -> 7 -> 4 -> 9 -> 10 -> 5 -> 3 -> 2 -> 1

31813

</pre></td></tr></table>

31814

This is, the sequence creates a single cycle through all 10 numbers.

31815

This is not always possible with a general permutation.

31816

31817

If you need a fixpoint-free permutation, you might choose to use a cyclic

31818

permutation instead, although not every fixpoint-free permutation is cyclic.

31819

31820

</dd>

31821

<dt> Full Example:</dt>

31822

<dd>If you want to connect an arbitrary number of meditation marbles with

31823

rubberbands in a cyclic manner, but otherwise randomly, you can use

31824

‘<samp>lib.math.cyclic_permutation</samp>’:

31825

<table><tr><td> </td><td><pre class="example">marbles = no["marbles#*"]

31826

p = lib.math.cyclic_permutation(#marbles)

31827

31828

for j = 1, #marbles do

31829

wo:add({"ot_rubberband", anchor1 = marbles[j], anchor2 = marbles[p[j]]})

31830

end

31831

</pre></td></tr></table>

31832

If you want to connect them in a linear way, you can either remove a step in

31833

the loop:

31834

<table><tr><td> </td><td><pre class="example">[...]

31835

for j = 1, #marbles - 1 do

31836

[...]

31837

</pre></td></tr></table>

31838

or use ‘<samp>lib.math.permutation</samp>’ in the following way:

31839

<table><tr><td> </td><td><pre class="example">marbles = no["marbles#*"]

31840

p = lib.math.permutation(#marbles)

31841

31842

for j = 1, #marbles - 1 do

31843

wo:add({"ot_rubberband", anchor1 = marbles[p[j]], anchor2 = marbles[p[j+1]]})

31844

end

31845

</pre></td></tr></table>

31846

</dd>

31847

</dl>

31848

31849

31850

31851

31852

31853

31854

31855

31856

31857

31858

31859

31860

31861

31862

31863

31864

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

31865

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

31866

31867

</tr></table>

31868

31869

<h3 class="subsection">12.3.4 lib.math.digits</h3>

31870

31871

31872

‘<samp>lib.math.digits</samp>’ returns a table whose elements are the digits of

31873

‘<samp>number</samp>’ in base ‘<samp>base</samp>’. ‘<samp>base</samp>’ can be a positive integer (e.g.

31874

3 to get ternary) as well as a table (then the table entries with numerical

31875

keys will be used as digits).

31876

31877

31878

<dt> Syntax:</dt>

31879

<dd>lib.math.digits(number, base [, zero_is_empty])

31880

31881

31882

<dt> number</dt>

31883

<dd>A non-negative integer.

31884

31885

</dd>

31886

31887

<dd>A positive integer other than 1, or a table with numerical keys.

31888

31889

</dd>

31890

<dt> zero_is_empty</dt>

31891

<dd>If <code>number</code> is zero, a table containing the zero-th digit is returned by

31892

default. If <code>zero_is_empty</code> is <code>true</code>, an empty table is returned

31893

instead.

31894

</dd>

31895

</dl>

31896

31897

</dd>

31898

<dt> Syntax Samples:</dt>

31899

<dd><table><tr><td> </td><td><pre class="example">lib.math.digits(13, 2) == {1, 0, 1, 1}

31900

lib.math.digits(15, 16) == {15}

31901

lib.math.digits(17, 3) == {2, 2, 1}

31902

lib.math.digits(17, {2, "b", 5}) == {5, 5, "b"}

31903

</pre></td></tr></table>

31904

31905

The following function can be used to get a table with hexadecimal entries:

31906

<table><tr><td> </td><td><pre class="example">lib.math.digits(x, {0,1,2,3,4,5,6,7,8,9,"A","B","C","D","E","F"})

31907

</pre></td></tr></table>

31908

31909

</dd>

31910

<dt> Details:</dt>

31911

<dt> Full Example:</dt>

31912

</dl>

31913

31914

31915

31916

31917

31918

31919

31920

31921

31922

31923

31924

31925

31926

31927

31928

31929

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

31930

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

31931

31932

</tr></table>

31933

31934

<h3 class="subsection">12.3.5 lib.math.manhattan_distance</h3>

31935

31936

31937

‘<samp>manhattan_distance</samp>’ calculates the Manhattan distance between two

31938

positions ‘<samp>pos1</samp>’ and ‘<samp>pos2</samp>’, which is

31939

<table><tr><td> </td><td><pre class="example">|pos1.x - pos2.x| + |pos1.y - pos2.y|.

31940

</pre></td></tr></table>

31941

31942

31943

<dt> Syntax:</dt>

31944

<dd>lib.math.manhattan_distance(pos1, pos2)

31945

31946

lib.math.manhattan_distance(x1, y1, x2, y2)

31947

31948

31949

31950

<dd>Positions (e.g. object references or tables ‘<samp>{posx, posy}</samp>’.

31951

31952

</dd>

31953

31954

<dd>Coordinates of the positions ‘<samp>pos1</samp>’ and ‘<samp>pos2</samp>’, respectively.

31955

</dd>

31956

</dl>

31957

31958

</dd>

31959

<dt> Syntax Samples:</dt>

31960

<dd><table><tr><td> </td><td><pre class="example">lib.math.manhattan_distance(4, 5, 3, 3)

31961

lib.math.manhattan_distance({4, 5}, {3, 3})

31962

lib.math.manhattan_distance(no["marble"], no["othermarble"])

31963

</pre></td></tr></table>

31964

31965

</dd>

31966

<dt> Details:</dt>

31967

<dd>The Manhattan distance counts the minimal number of pushes necessary to push a

31968

wood stone from one position to another. Its unit balls are squares with the

31969

diagonals parallel to the x- and y-axis (rhombi).

31970

31971

</dd>

31972

<dt> Full Example:</dt>

31973

</dl>

31974

31975

31976

31977

31978

31979

31980

31981

31982

31983

31984

31985

31986

31987

31988

31989

31990

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

31991

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

31992

31993

</tr></table>

31994

31995

<h3 class="subsection">12.3.6 lib.math.mark_components</h3>

31996

31997

31998

‘<samp>mark_components</samp>’ calculates the connected components of a group of

31999

floors. Two floors are directly connected if their difference is within a given

32000

polist (or <code>NEIGHBORS_4</code>, by default). A table is returned holding a

32001

list of groups, each group is a complete connected component.

32002

In turn, an attribute is attached to each floor of the group which holds the

32003

number of its component. The name of this attribute can be chosen freely.

32004

32005

32006

<dt> Syntax:</dt>

32007

<dd>lib.math.mark_components(group, attribute_name [, neighborhood [,

32008

exclusive_attribute]])

32009

32010

32011

<dt> group</dt>

32012

<dd>A group of floors.

32013

32014

</dd>

32015

<dt> attribute_name</dt>

32016

<dd>A non-empty string. Typically, this is the title of a user attribute, so it

32017

should start with an underscore ‘<samp>_</samp>’, unless you want to feat the

32018

information directly to a non-user attribute which takes numerical values.

32019

32020

</dd>

32021

<dt> neighborhood</dt>

32022

<dd>A symmetric polist (see details). Defaults to <code>NEIGHBORS_4</code>, which results

32023

in a calculation of path-connected components.

32024

32025

</dd>

32026

<dt> exclusive_attribute</dt>

32027

<dd>A boolean (<code>false</code> by default) which can be set to <code>true</code>, if there is

32028

no other floor which uses an attribute named attribute_name.

32029

</dd>

32030

</dl>

32031

32032

</dd>

32033

<dt> Syntax Samples:</dt>

32034

<dd><table><tr><td> </td><td><pre class="example">lib.math.mark_components(all_floors, "_component")

32035

local number = #lib.math.mark_components(all_floors, "_component", NEIGHBORS_CHESS .. NEIGHBORS_4)

32036

local lines = lib.math.mark_components(all_floors, "_linenumber", po(-1, 0) .. po(1, 0), true)

32037

</pre></td></tr></table>

32038

32039

</dd>

32040

<dt> Details:</dt>

32041

<dd>‘<samp>mark_components</samp>’ returns a Lua-table of groups, the table has natural numbers

32042

as indizes counting up starting from <code>1</code>, s.t. you can access the total

32043

number of components via ‘<samp>#</samp>’. Each entry of the table is a subgroup of

32044

<code>group</code>, a complete connected component. The sequence of the components is

32045

determined by the sequence of the floors in <code>group</code>.

32046

32047

You have to choose an attribute, as it is used during the calculation.

32048

Note that all prior information saved in this attribute is lost.

32049

Also note that choosing a read-only attribute results in an error.

32050

32051

The chosen neighborhood has to be a symmetric polist, i.e. if it contains the

32052

position <code>po(x, y)</code> it also has to contain the position <code>po(-x, -y)</code>

32053

at some point. Mathematically speaking, we analyze the connected components of

32054

an undirected graph, not of a directed graph.

32055

32056

If you know that there is no other floor which uses the attribute

32057

<code>attribute_name</code>, you may set ‘<samp>exclusive_attribute</samp>’ to ‘<samp>true</samp>’.

32058

This will result in a much faster algorithm.

32059

32060

</dd>

32061

<dt> Full Example:</dt>

32062

</dl>

32063

32064

32065

32066

32067

32068

32069

32070

32071

32072

32073

32074

32075

32076

32077

32078

32079

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

32080

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

32081

32082

</tr></table>

32083

32084

<h3 class="subsection">12.3.7 lib.math.permutation</h3>

32085

32086

32087

‘<samp>permutation</samp>’ returns a random permutation (i.e. a random shuffling) of the

32088

numbers 1 to ‘<samp>n</samp>’.

32089

32090

32091

<dt> Syntax:</dt>

32092

<dd>lib.math.permutation(n)

32093

32094

32095

32096

<dd>A positive integer.

32097

</dd>

32098

</dl>

32099

32100

</dd>

32101

<dt> Syntax Samples:</dt>

32102

<dd><table><tr><td> </td><td><pre class="example">lib.math.permutation(#no["doors#*"])

32103

</pre></td></tr></table>

32104

32105

</dd>

32106

<dt> Details:</dt>

32107

<dd>Permutations give a simple way to randomize a level, e.g. by changing the

32108

assignment of action/target-pairs ("Which trigger to which door?").

32109

32110

</dd>

32111

<dt> Full Example:</dt>

32112

</dl>

32113

32114

32115

32116

32117

32118

32119

32120

32121

32122

32123

32124

32125

32126

32127

32128

32129

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

32130

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

32131

32132

</tr></table>

32133

32134

<h3 class="subsection">12.3.8 lib.math.random_vector</h3>

32135

32136

32137

‘<samp>random_vector</samp>’ returns a table of ‘<samp>n</samp>’ random entries.

32138

32139

32140

<dt> Syntax:</dt>

32141

<dd>lib.math.random_vector(n, ...)

32142

32143

32144

32145

<dd>A non-negative integer.

32146

32147

</dd>

32148

32149

<dd>Further arguments, which are the same as for ‘<samp>math.random</samp>’: Either no

32150

further arguments, then the random numbers will be float values in

32151

‘<samp>[0,1)</samp>’, or with one additional number ‘<samp>p</samp>’, then the random numbers

32152

will be integers between 1 and ‘<samp>p</samp>’ (both included), or two additional

32153

numbers ‘<samp>p, q</samp>’, then the random numbers will be integers between ‘<samp>p</samp>’

32154

and ‘<samp>q</samp>’ (both included).

32155

</dd>

32156

</dl>

32157

32158

</dd>

32159

<dt> Syntax Samples:</dt>

32160

<dd><table><tr><td> </td><td><pre class="example">lib.math.random_vector(4, 3)

32161

</pre></td></tr></table>

32162

will return a table of 4 random numbers out of {1,2,3}, and

32163

<table><tr><td> </td><td><pre class="example">lib.math.random_vector(22)

32164

</pre></td></tr></table>

32165

returns a table of 22 float values between 0.0 and 1.0 (excluding 1.0).

32166

32167

</dd>

32168

<dt> Details:</dt>

32169

<dd>‘<samp>random_vector</samp>’ can be used in conjunction with ‘<samp>cubic_polynomial</samp>’ to

32170

create random patterns, see <a href="#lib_002emath_002ecubic_005fpolynomial">lib.math.cubic_polynomial</a> and

32171

<a href="#Weirdly-Wired">Weirdly Wired</a>.

32172

32173

</dd>

32174

<dt> Full Example:</dt>

32175

</dl>

32176

32177

32178

32179

32180

32181

32182

32183

32184

32185

32186

32187

32188

32189

32190

32191

32192

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

32193

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

32194

32195

</tr></table>

32196

32197

<h3 class="subsection">12.3.9 lib.math.steps</h3>

32198

32199

32200

‘<samp>steps</samp>’ takes a number ‘<samp>d</samp>’ and a table of numbers as arguments and

32201

returns the index of the first number larger or equal ‘<samp>d</samp>’, minus one.

32202

I.e. it classifies ‘<samp>d</samp>’ into the intervals given by the table, starting

32203

with zero, when ‘<samp>d</samp>’ is smaller than the first number in the table, one,

32204

when ‘<samp>d</samp>’ is larger or equal to the first, but smaller than the second

32205

number, and so on.

32206

32207

32208

<dt> Syntax:</dt>

32209

<dd>lib.math.steps(discriminator, steps)

32210

32211

32212

<dt> discriminator</dt>

32213

<dd>A number.

32214

32215

</dd>

32216

<dt> steps</dt>

32217

<dd>A table of numbers.

32218

</dd>

32219

</dl>

32220

32221

</dd>

32222

<dt> Syntax Samples:</dt>

32223

<dd><table><tr><td> </td><td><pre class="example">number_pairs = lib.math.steps(total_places, {2, 6, 10, 30})

32224

</pre></td></tr></table>

32225

32226

</dd>

32227

<dt> Details:</dt>

32228

<dd>Negative and non-integer values are allowed. However, the numbers in the

32229

‘<samp>steps</samp>’-table should be monotonously increasing (not necessarily strictly

32230

monotonously), as otherwise the result might be counter-intuitive.

32231

32232

</dd>

32233

<dt> Full Example:</dt>

32234

<dd><table><tr><td> </td><td><pre class="example">lib.math.steps(x, {4, 8, 13})

32235

</pre></td></tr></table>

32236

returns:

32237

<table><tr><td> </td><td><pre class="example"> 0 if x < 4

32238

1 if 4 <= x < 8

32239

2 if 8 <= x < 13

32240

3 if 13 <= x

32241

</pre></td></tr></table>

32242

</dd>

32243

</dl>

32244

32245

32246

32247

32248

32249

32250

32251

32252

32253

32254

32255

32256

32257

32258

32259

32260

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

32261

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

32262

32263

</tr></table>

32264

32265

<h2 class="section">12.4 libmap</h2>

32266

32267

The ‘<samp>libmap</samp>’ gives the author more possibilities to work with API 2-maps.

32268

Up to now, a map just is a table of strings, as described in

32269

<a href="#World-Creation">World Creation</a>. With ‘<samp>libmap</samp>’, you can utilize maps in a more

32270

advanced way.

32271

32272

This library is described as of release 1.

32273

32274

You can load it by adding an ‘<samp>dependency</samp>’ element to the

32275

<a href="#g_t_003ccompatibility_003e"><compatibility></a> XML Metadata element as follows:

32276

32277

<table><tr><td> </td><td><pre class="example"> <el:dependency el:path="<var>lib/libmap</var>" el:id="<var>lib/libmap</var>" el:release="<var>1</var>" el:preload="<var>true</var>"/>

32278

</pre></td></tr></table>

32279

32280

It preloads automatically the library <a href="#liblua">liblua</a>.

32281

32282

We first give six task-oriented sections, then describe each function in detail.

32283

32284

32285

<tr><td align="left" valign="top"><a href="#Creating-Maps">12.4.1 Creating Maps</a></td><td>  </td><td align="left" valign="top">

32286

</td></tr>

32287

<tr><td align="left" valign="top"><a href="#Drawing-Maps">12.4.2 Drawing Maps</a></td><td>  </td><td align="left" valign="top">

32288

</td></tr>

32289

<tr><td align="left" valign="top"><a href="#Rotating-and-Mirroring-Maps">12.4.3 Rotating and Mirroring Maps</a></td><td>  </td><td align="left" valign="top">

32290

</td></tr>

32291

<tr><td align="left" valign="top"><a href="#Requesting-and-Changing-Single-Map-Entries">12.4.4 Requesting and Changing Single Map Entries</a></td><td>  </td><td align="left" valign="top">

32292

</td></tr>

32293

<tr><td align="left" valign="top"><a href="#Connecting-Two-Maps">12.4.5 Connecting Two Maps</a></td><td>  </td><td align="left" valign="top">

32294

</td></tr>

32295

<tr><td align="left" valign="top"><a href="#Other-Map-Tasks">12.4.6 Other Map Tasks</a></td><td>  </td><td align="left" valign="top">

32296

</td></tr>

32297

<tr><td align="left" valign="top"><a href="#newMap">12.4.7 newMap</a></td><td>  </td><td align="left" valign="top">

32298

</td></tr>

32299

<tr><td align="left" valign="top"><a href="#Map-Entry-Request">12.4.8 Map Entry Request</a></td><td>  </td><td align="left" valign="top"> Index Operator ‘<samp>[]</samp>’ read and write

32300

</td></tr>

32301

<tr><td align="left" valign="top"><a href="#Map-Transformation">12.4.9 Map Transformation</a></td><td>  </td><td align="left" valign="top"> Operator ‘<samp>^</samp>’

32302

</td></tr>

32303

<tr><td align="left" valign="top"><a href="#Map-Horizontal-Concatenation">12.4.10 Map Horizontal Concatenation</a></td><td>  </td><td align="left" valign="top"> Operator ‘<samp>..</samp>’

32304

</td></tr>

32305

<tr><td align="left" valign="top"><a href="#Map-Vertical-Concatenation">12.4.11 Map Vertical Concatenation</a></td><td>  </td><td align="left" valign="top"> Operator ‘<samp>+</samp>’

32306

</td></tr>

32307

<tr><td align="left" valign="top"><a href="#Map-Fusing">12.4.12 Map Fusing</a></td><td>  </td><td align="left" valign="top"> Operator ‘<samp>*</samp>’

32308

</td></tr>

32309

<tr><td align="left" valign="top"><a href="#Map-Default-Keys">12.4.13 Map Default Keys</a></td><td>  </td><td align="left" valign="top">

32310

</td></tr>

32311

<tr><td align="left" valign="top"><a href="#Map-Width-and-Height">12.4.14 Map Width and Height</a></td><td>  </td><td align="left" valign="top">

32312

</td></tr>

32313

<tr><td align="left" valign="top"><a href="#lib_002emap_002ecovers">12.4.15 lib.map.covers</a></td><td>  </td><td align="left" valign="top">

32314

</td></tr>

32315

<tr><td align="left" valign="top"><a href="#lib_002emap_002edefuse">12.4.16 lib.map.defuse</a></td><td>  </td><td align="left" valign="top">

32316

</td></tr>

32317

<tr><td align="left" valign="top"><a href="#lib_002emap_002eextend">12.4.17 lib.map.extend</a></td><td>  </td><td align="left" valign="top">

32318

</td></tr>

32319

<tr><td align="left" valign="top"><a href="#lib_002emap_002ematch">12.4.18 lib.map.match</a></td><td>  </td><td align="left" valign="top">

32320

</td></tr>

32321

<tr><td align="left" valign="top"><a href="#lib_002emap_002epaste">12.4.19 lib.map.paste</a></td><td>  </td><td align="left" valign="top">

32322

</td></tr>

32323

<tr><td align="left" valign="top"><a href="#lib_002emap_002eprint">12.4.20 lib.map.print</a></td><td>  </td><td align="left" valign="top">

32324

</td></tr>

32325

<tr><td align="left" valign="top"><a href="#lib_002emap_002ereplace">12.4.21 lib.map.replace</a></td><td>  </td><td align="left" valign="top">

32326

</td></tr>

32327

<tr><td align="left" valign="top"><a href="#lib_002emap_002ereplace_005foutside">12.4.22 lib.map.replace_outside</a></td><td>  </td><td align="left" valign="top">

32328

</td></tr>

32329

32330

</td></tr>

32331

32332

</td></tr>

32333

<tr><td align="left" valign="top"><a href="#Map-Transformation-Index-and-MAP_005fALL">12.4.25 Map Transformation Index and MAP_ALL</a></td><td>  </td><td align="left" valign="top">

32334

</td></tr>

32335

<tr><td align="left" valign="top"><a href="#Map-Transformation-Composition-and-Powers">12.4.26 Map Transformation Composition and Powers</a></td><td>  </td><td align="left" valign="top"> Operators ‘<samp>*</samp>’ and ‘<samp>^</samp>’

32336

</td></tr>

32337

<tr><td align="left" valign="top"><a href="#Map-Transformation-Inverse">12.4.27 Map Transformation Inverse</a></td><td>  </td><td align="left" valign="top"> Operator ‘<samp>-</samp>’

32338

</td></tr>

32339

<tr><td align="left" valign="top"><a href="#Random-Map-Transformations">12.4.28 Random Map Transformations</a></td><td>  </td><td align="left" valign="top">

32340

</td></tr>

32341

</table>

32342

32343

32344

32345

32346

32347

32348

32349

32350

32351

32352

32353

32354

32355

32356

32357

32358

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

32359

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

32360

32361

</tr></table>

32362

32363

<h3 class="subsection">12.4.1 Creating Maps</h3>

32364

32365

We start by defining a table of strings representing the level we want to

32366

write in a two-dimensional array of tile keys:

32367

32368

<table><tr><td> </td><td><pre class="example">mypremap = {"# # # # # # # ",

32369

"o t1 # t2o ",

32370

"# # # ",

32371

"# d2d1# # ",

32372

"# @1# @2# ",

32373

"# # # t1# ",

32374

"o d3 t3o ",

32375

"# # # # # # # "}

32376

</pre></td></tr></table>

32377

32378

To not get confused with names, in this section we’ll call such a table of

32379

strings a ’premap’. We create a map (in the sense of libmap) by applying

32380

‘<samp>wo:newMap</samp>’ to it, with a default key and the premap as arguments:

32381

<table><tr><td> </td><td><pre class="example">mymap = wo:newMap(" ", mypremap)

32382

</pre></td></tr></table>

32383

The default key is saved in ‘<samp>mymap</samp>’ as well, it’s part of a map.

32384

32385

You can use

32386

<table><tr><td> </td><td><pre class="example">mymap = wo:newMap(key, height, width)

32387

</pre></td></tr></table>

32388

to define map of size ‘<samp>height*width</samp>’, where every tile key is ‘<samp>key</samp>’,

32389

and the default key is set to ‘<samp>key</samp>’ as well. You might even omit

32390

‘<samp>height</samp>’ and ‘<samp>width</samp>’, then you create a map consisting of only one

32391

character.

32392

32393

32394

32395

32396

32397

32398

32399

32400

32401

32402

32403

32404

32405

32406

32407

32408

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

32409

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

32410

32411

</tr></table>

32412

32413

<h3 class="subsection">12.4.2 Drawing Maps</h3>

32414

32415

Just as we could have used the premap with ‘<samp>wo</samp>’ or ‘<samp>wo:drawMap</samp>’ to draw

32416

it (see <a href="#drawMap">drawMap</a>), we can use the newly created map as well:

32417

<table><tr><td> </td><td><pre class="example">wo(resolver, mymap)

32418

wo:drawMap(resolver, anchor, mymap)

32419

wo:drawMap(resolver, anchor, ignore, mymap)

32420

</pre></td></tr></table>

32421

When the ‘<samp>ignore</samp>’-attribute for ‘<samp>drawMap</samp>’ is omitted, the default key

32422

of ‘<samp>mymap</samp>’ is used instead.

32423

32424

Of course you can draw the map multiple times, even from within a resolver, see

32425

<a href="#drawMap">drawMap</a> for a full example.

32426

32427

32428

32429

32430

32431

32432

32433

32434

32435

32436

32437

32438

32439

32440

32441

32442

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

32443

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

32444

32445

</tr></table>

32446

32447

<h3 class="subsection">12.4.3 Rotating and Mirroring Maps</h3>

32448

32449

We can transform a single map simply by using one of the following commands:

32450

<table><tr><td> </td><td><pre class="example">newmap = lib.map.transform(mymap, maptransformation)

32451

newmap = mymap ^ maptransformation

32452

</pre></td></tr></table>

32453

‘<samp>maptransformation</samp>’ can be any of the following constants:

32454

32455

<dt> ‘<samp>MAP_IDENT</samp>’</dt>

32456

<dd>No transformation.

32457

</dd>

32458

32459

<dd>Rotate 90 degrees clockwise.

32460

</dd>

32461

32462

<dd>Rotate 180 degrees (i.e. a point reflection around the midpoint).

32463

</dd>

32464

32465

<dd>Rotate 90 degrees counter-clockwise.

32466

</dd>

32467

<dt> ‘<samp>MAP_FLIP_HORIZONTAL</samp>’</dt>

32468

<dd>Flip each horizontal line, i.e. mirror against a vertical mirror: left and right are swapped.

32469

</dd>

32470

<dt> ‘<samp>MAP_FLIP_VERTICAL</samp>’</dt>

32471

<dd>Flip each vertical line, i.e. mirror against a horizontal mirror: up and down are swapped.

32472

</dd>

32473

<dt> ‘<samp>MAP_FLIP_SLASH</samp>’</dt>

32474

<dd>Flip each <code>/</code>-diagonal, i.e. mirror against a <code>\</code>-mirror: upper-right and

32475

lower-left corners are swapped.

32476

</dd>

32477

<dt> ‘<samp>MAP_FLIP_BACKSLASH</samp>’</dt>

32478

<dd>Flip each <code>\</code>-diagonal, i.e. mirror against a <code>/</code>-mirror: upper-left

32479

and lower-right corners are swapped.

32480

</dd>

32481

</dl>

32482

32483

When you apply multiple transformations, remember that their sequence

32484

matters. If you use

32485

<table><tr><td> </td><td><pre class="example">newmap = mymap ^ maptransformation1 ^ maptransformation2 ^ maptransformation3

32486

</pre></td></tr></table>

32487

then <code>maptransformation1</code> acts first on <code>mymap</code>, then comes

32488

<code>maptransformation2</code>, and <code>maptransformation3</code> is

32489

last. However, composing transformations is associative, so you can use

32490

<table><tr><td> </td><td><pre class="example">newmap = mymap ^ ((maptransformation1 ^ maptransformation2) ^ maptransformation3)

32491

</pre></td></tr></table>

32492

or

32493

<table><tr><td> </td><td><pre class="example">newmap = (mymap ^ maptransformation1) ^ (maptransformation2 ^ maptransformation3)

32494

</pre></td></tr></table>

32495

to the same effect. Keep in mind that composing transformations is by far faster than

32496

applying transformations to maps. So the first example is faster than the

32497

second. Due to Lua’s sequence of evaluating operators,

32498

<table><tr><td> </td><td><pre class="example">newmap = mymap ^ maptransformation1 ^ maptransformation2 ^ maptransformation3

32499

</pre></td></tr></table>

32500

equals

32501

<table><tr><td> </td><td><pre class="example">newmap = mymap ^ (maptransformation1 ^ (maptransformation2 ^ maptransformation3))

32502

</pre></td></tr></table>

32503

and hence already is the fastest possible sequence.

32504

32505

For composing transformations you may use <code>^</code> as well as <code>*</code>. You

32506

can also use <code>maptransformation ^ n</code> to calculate the n-th power of

32507

<code>maptransformation</code> for any integer n. The inverse of a transformation is

32508

given by <code>-maptransformation</code>, so

32509

<table><tr><td> </td><td><pre class="example">MAP_ROT_CW * (-MAP_ROT_CW) == MAP_IDENT

32510

</pre></td></tr></table>

32511

32512

32513

32514

32515

32516

32517

32518

32519

32520

32521

32522

32523

32524

32525

32526

32527

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

32528

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

32529

32530

</tr></table>

32531

32532

<h3 class="subsection">12.4.4 Requesting and Changing Single Map Entries</h3>

32533

32534

Let’s take a look at our example again:

32535

<table><tr><td> </td><td><pre class="example">mymap = wo:newMap(" ", {"# # # # # # # ",

32536

"o t1 # t2o ",

32537

"# # # ",

32538

"# d2d1# # ",

32539

"# @1# @2# ",

32540

"# # # t1# ",

32541

"o d3 t3o ",

32542

"# # # # # # # "})

32543

</pre></td></tr></table>

32544

It’s easy to check, what kind of tile key is at position <code>{1,1}</code> (note

32545

that the upper left corner is at position <code>{0,0}</code>):

32546

<table><tr><td> </td><td><pre class="example">mymap[{1, 1}] == "t1"

32547

</pre></td></tr></table>

32548

It’s similarly easy to change it. Let’s say, we want to create a passage

32549

one tile right beside the second marble ‘<samp>@2</samp>’, which is named

32550

‘<samp>marble2</samp>’:

32551

<table><tr><td> </td><td><pre class="example">mymap[no["marble2"] + {1,0}] = " "

32552

</pre></td></tr></table>

32553

Note that the reference to ‘<samp>marble2</samp>’ only works after the marble has been

32554

set.

32555

32556

Requesting and changing map entries can be used with position lists, object and

32557

group references as well.

32558

32559

You can replace any occurrence of a tile key ‘<samp>tile1</samp>’ by ‘<samp>tile2</samp>’ simply

32560

by

32561

<table><tr><td> </td><td><pre class="example">mymap:replace(tile1, tile2)

32562

</pre></td></tr></table>

32563

You can omit ‘<samp>tile2</samp>’, then any occurrence of ‘<samp>tile1</samp>’ will be replaced

32564

by the default key.

32565

32566

You can also search for positions in a map which fulfill given conditions by

32567

using ‘<samp>match</samp>’, the return value is a position list. The syntax is simple:

32568

<table><tr><td> </td><td><pre class="example">mymap:match()

32569

mymap:match(tilekey)

32570

mymap:match({pos1, key1a, key1b, ...}, {pos2, key2a, key2b, ...}, ...)

32571

mymap:match({{pos1, key1a, key1b, ...}, {pos2, key2a, key2b, ...}, ...})

32572

</pre></td></tr></table>

32573

The first call will return all positions of the map. The second call will

32574

return all positions with the desired <code>tilekey</code>. The third and fourth call

32575

will return all positions <code>x</code> such that <code>x + pos1</code> is one of the keys

32576

<code>key1a</code> or <code>key1b</code> or ..., and such that <code>x + pos2</code> is one of

32577

the keys <code>key2a</code>, <code>2b</code>, ..., and so on. A tile outside of the map is

32578

considered to be a default key.

32579

32580

The resulting position list can then be used to replace the matching tile keys:

32581

<table><tr><td> </td><td><pre class="example">mymap[mymap:match(oldkey)] = newkey

32582

</pre></td></tr></table>

32583

is equivalent to ‘<samp>mymap:replace(oldkey, newkey)</samp>’ (only slower), and

32584

<table><tr><td> </td><td><pre class="example">mymap[mymap:match({po(0,0), " "}, {NEIGHBORS_4, ".", ":"})] = "."

32585

</pre></td></tr></table>

32586

will find all occurrences of ‘<samp> </samp>’, which are completely surrounded by

32587

‘<samp>.</samp>’, or ‘<samp>:</samp>’, or mixtures of these, and replace them by ‘<samp>.</samp>’. As

32588

all replacements are done after matching, and hence simultaneously, the newly

32589

introduced ‘<samp>.</samp>’ will not participate in the matching.

32590

32591

32592

32593

32594

32595

32596

32597

32598

32599

32600

32601

32602

32603

32604

32605

32606

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

32607

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

32608

32609

</tr></table>

32610

32611

<h3 class="subsection">12.4.5 Connecting Two Maps</h3>

32612

32613

Given two maps ‘<samp>map1</samp>’ and ‘<samp>map2</samp>’, we can glue them together

32614

horizontally by ‘<samp>map1 .. map2</samp>’ as well as vertically with ‘<samp>map1 +

32615

map2</samp>’. Missing entries will be filled with the default key of the respective

32616

map, the default key of the result will be the one of ‘<samp>map1</samp>’. A simple

32617

example:

32618

<table><tr><td> </td><td><pre class="example">map1 = wo:newMap(" ", {"####",

32619

"o #",

32620

"# w#",

32621

"####"})

32622

map2 = wo:newMap(".", {"#######",

32623

"#w.#..#",

32624

"#..D..#",

32625

"#..#.w#",

32626

"#######"})

32627

map1 .. map2 == wo:newMap(" ", {"###########",

32628

"o ##w.#..#",

32629

"# w##..D..#",

32630

"#####..#.w#",

32631

" #######"})

32632

map2 .. map1 == wo:newMap(".", {"###########",

32633

"#w.#..#o #",

32634

"#..D..## w#",

32635

"#..#.w#####",

32636

"####### "})

32637

map1 + map2 == wo:newMap(" ", {"#### ",

32638

"o # ",

32639

"# w# ",

32640

"#### ",

32641

"#######",

32642

"#w.#..#",

32643

"#..D..#",

32644

"#..#.w#",

32645

"#######"})

32646

</pre></td></tr></table>

32647

32648

It’s also possible to paste a map into another map:

32649

<table><tr><td> </td><td><pre class="example">map1:paste(map2, pos)

32650

</pre></td></tr></table>

32651

will paste ‘<samp>map2</samp>’ into ‘<samp>map1</samp>’ at position ‘<samp>pos</samp>’ (relative to

32652

‘<samp>map1</samp>’: <code>{0,0}</code> is the upper left edge). If necessary, ‘<samp>map1</samp>’

32653

will be extended such that the whole of ‘<samp>map2</samp>’ fits into it. You can use

32654

‘<samp>map1.sub</samp>’ to reduce its size again (see below) as well as to define

32655

‘<samp>map2</samp>’ as a section of another map. During the pasting, any occurrence of

32656

the default key of ‘<samp>map2</samp>’ will be ignored, i.e. not drawn onto

32657

‘<samp>map1</samp>’. You can change the default key with ‘<samp>map2.defaultkey = ...</samp>’

32658

prior to the paste command to circumvent this, or use

32659

‘<samp>map2:replace(tile)</samp>’ to replace more tile keys by the default key, such

32660

that they are not drawn as well. You can use an object group or position list

32661

for ‘<samp>pos</samp>’, in this case several copies of ‘<samp>map2</samp>’ will be pasted into

32662

‘<samp>map1</samp>’. In the first case, there is no guarantee about the sequence in

32663

which the maps will be pasted into ‘<samp>map1</samp>’. In the second case, a latter

32664

entry in the position list may overwrite the result of earlier entries.

32665

32666

However, there’s a fourth possibility: Two maps may represent two different

32667

parts of tile keys. Let’s give an example to fuse two tile key layers:

32668

<table><tr><td> </td><td><pre class="example">first_char = wo:newMap(".", {"#######",

32669

"#w.#..#",

32670

"#..D..#",

32671

"#..#.w#",

32672

"#######"})

32673

last_char = wo:newMap(".", {"C C",

32674

" 11 22 ",

32675

" 11322 ",

32676

" 11 22 ",

32677

"C C"})

32678

first_char * last_char = wo:newMap(" .", {"#C# # # # # #C",

32679

"# w1.1# .2.2# ",

32680

"# .1.1D3.2.2# ",

32681

"# .1.1# .2w2# ",

32682

"#C# # # # # #C"})

32683

</pre></td></tr></table>

32684

The default key of the fused map is the concatenation of the two original

32685

default keys. You can use a string instead of any of the two maps, in this case

32686

the whole tile key layer will consist of this string everywhere:

32687

<table><tr><td> </td><td><pre class="example">first_char = wo:newMap(".", {"#######",

32688

"#w.#..#",

32689

"#..D..#",

32690

"#..#.w#",

32691

"#######"})

32692

first_char * "u" = wo:newMap(" u", {"#u#u#u#u#u#u#u",

32693

"#uwu.u#u.u.u#u",

32694

"#u.u.uDu.u.u#u",

32695

"#u.u.u#u.uwu#u",

32696

"#u#u#u#u#u#u#u"})

32697

32698

</pre></td></tr></table>

32699

Fusing maps can be a mighty technique in combination with the

32700

<a href="#res_002ecomposer">res.composer</a>- and <a href="#res_002eautotile">res.autotile</a>-resolvers.

32701

32702

A map can also be defused: ‘<samp>map:defuse()</samp>’ will return a table of maps,

32703

where each map is of keylength one, holding the corresponding subkey character.

32704

32705

32706

32707

32708

32709

32710

32711

32712

32713

32714

32715

32716

32717

32718

32719

32720

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

32721

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

32722

32723

</tr></table>

32724

32725

<h3 class="subsection">12.4.6 Other Map Tasks</h3>

32726

32727

You can access the default key of a map by ‘<samp>mymap.defaultkey</samp>’, and change

32728

it just as easily:

32729

<table><tr><td> </td><td><pre class="example">mymap.defaultkey = ".3"

32730

mymap:set_default_key(".3")

32731

</pre></td></tr></table>

32732

The new default key should have the same length as the old one. However, it is

32733

possible to choose a new key length as long as it fits to the map.

32734

32735

Width and height of a map can be accessed via ‘<samp>mymap.width</samp>’ and

32736

‘<samp>mymap.height</samp>’. However, these values can be changed only through the

32737

following commands ‘<samp>mymap:extend</samp>’ and ‘<samp>mymap:sub</samp>’.

32738

32739

It’s possible to extend a map to a given position, as long as both

32740

coordinates are non-negative:

32741

<table><tr><td> </td><td><pre class="example">mymap:extend({19, 12})

32742

</pre></td></tr></table>

32743

will extend ‘<samp>mymap</samp>’ up to position ‘<samp>{19,12}</samp>’. Missing entries will

32744

be filled with the default key. If the map already covers this position, no

32745

change will be done.

32746

32747

If you want to check whether a position ‘<samp>pos</samp>’ lies inside a map, you can

32748

use ‘<samp>mymap:covers(pos)</samp>’, which returns a boolean value. Note that a map

32749

always starts in ‘<samp>{0,0}</samp>’.

32750

32751

‘<samp>lib.map.sub</samp>’ allows you to copy a rectangular area of a map and create a

32752

"submap" this way. ‘<samp>lib.map.sub</samp>’ uses the same syntax as

32753

‘<samp>wo:drawRect</samp>’, i.e. either

32754

<table><tr><td> </td><td><pre class="example">submap = mymap:sub(pos1, pos2)

32755

</pre></td></tr></table>

32756

with ‘<samp>pos1</samp>’ being the top left-hand corner and ‘<samp>pos2</samp>’ the bottom

32757

right-hand corner, or alternatively

32758

<table><tr><td> </td><td><pre class="example">submap = mymap:sub(pos1, width, height)

32759

</pre></td></tr></table>

32760

to define the rectangle by its top left-hand corner and the side lengths of its

32761

area. If the bottom right-hand corner overlaps the area of ‘<samp>mymap</samp>’, the

32762

resulting ‘<samp>submap</samp>’ will still be just the rectangular section of

32763

‘<samp>mymap</samp>’, i.e. width and height can be less than the arguments specified.

32764

Use ‘<samp>submap:extend(width, height)</samp>’ to ensure the full width and height.

32765

The default key of the submap of course is the default key of the original map.

32766

32767

‘<samp>lib.map.trim</samp>’ or ‘<samp>mymap:trim(tilekey)</samp>’ removes all lines and

32768

columns from the North, South, East, and West that consist of <code>tilekey</code>

32769

only; it’s like trimming a string from white spaces. You can omit

32770

‘<samp>tilekey</samp>’, then the default key is used instead.

32771

32772

‘<samp>mymap:replace_outside(tile1, tile2)</samp>’ is a kind of combination of

32773

‘<samp>replace</samp>’ and ‘<samp>trim</samp>’: All occurrences of <code>tile1</code>, which are

32774

connected to the border by a path of ‘<samp>tile1</samp>’, are replaced by

32775

<code>tile2</code> (or default key). Example:

32776

<table><tr><td> </td><td><pre class="example">map1 = wo:newMap(" ", {" ##########",

32777

"### ##",

32778

"F# D ## # #",

32779

"# # #",

32780

"######## "})

32781

map2 = wo:newMap(" ", map1)

32782

map1:replace_outside(" ", ".")

32783

map2:replace_outside(" ", "#")

32784

map2:replace_outside("#", ".")

32785

</pre></td></tr></table>

32786

will yield:

32787

<table><tr><td> </td><td><pre class="example">map1 = {".##########",

32788

"### ##",

32789

"F# D ## #.#",

32790

"# #.#",

32791

"########..."})

32792

map2 = {"...........",

32793

"... ..",

32794

"F. D ## ...",

32795

". ...",

32796

"..........."})

32797

</pre></td></tr></table>

32798

You can combine ‘<samp>replace_outside</samp>’ with ‘<samp>match</samp>’ to remove irrelevant

32799

walls:

32800

<table><tr><td> </td><td><pre class="example">map1.defaultkey = "-"

32801

map1:replace_outside(" ")

32802

map1[map1:match({{po(0,0), "#"}, {NEIGHBORS_4, "-", "#", "F"}})] = "-"

32803

map1:trim()

32804

map1.defaultkey = " "

32805

</pre></td></tr></table>

32806

will yield:

32807

<table><tr><td> </td><td><pre class="example">map1 = {"---######-",

32808

"--# #",

32809

"F# D ## #-",

32810

"# #-",

32811

"-#######--"})

32812

</pre></td></tr></table>

32813

32814

Finally, you can use ‘<samp>mymap:print()</samp>’ to print ‘<samp>mymap</samp>’ to standard

32815

output. Similar to <a href="#lib_002elua_002eprint_005ftable">lib.lua.print_table</a>, this is useful for debugging a

32816

level by taking a look at its maps, but should not appear in the final level.

32817

‘<samp>mymap:print()</samp>’ allows several optional arguments:

32818

<table><tr><td> </td><td><pre class="example">mymap:print(withXYCounts, left_separator, right_separator)

32819

</pre></td></tr></table>

32820

If ‘<samp>withXYCounts</samp>’ is ‘<samp>true</samp>’, the map is printed with coordinates on

32821

the top and on the left. ‘<samp>left_separator</samp>’ and ‘<samp>right_separator</samp>’ can

32822

be strings to be put between the left coordinate axis and the map, and behind

32823

the map (to analyse space characters).

32824

32825

32826

32827

32828

32829

32830

32831

32832

32833

32834

32835

32836

32837

32838

32839

32840

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

32841

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

32842

32843

</tr></table>

32844

32845

<h3 class="subsection">12.4.7 newMap</h3>

32846

32847

32848

‘<samp>wo:newMap</samp>’ takes a default key, and a premap or width and height as

32849

arguments, and returns a libmap-map.

32850

32851

32852

<dt> Syntax:</dt>

32853

<dd>mymap = wo:newMap(defaultkey, premap)

32854

32855

mymap = wo:newMap(defaultkey, width, height)

32856

32857

mymap = wo:newMap(defaultkey)

32858

32859

32860

<dt> defaultkey</dt>

32861

<dd>A non-empty string, which becomes the default key of the new map.

32862

32863

</dd>

32864

<dt> premap</dt>

32865

<dd>A table of strings. It may have lines of varying length, but each line length

32866

must be divisible by the length of the default key.

32867

32868

</dd>

32869

<dt> width, height</dt>

32870

<dd>Positive integers. If width and height are given instead of a premap, a

32871

rectangular map consisting of the default key only is returned.

32872

</dd>

32873

</dl>

32874

32875

If neither a premap, nor width and height are given, a 1x1-map with the default

32876

key is returned.

32877

32878

</dd>

32879

<dt> Syntax Samples:</dt>

32880

<dd>See <a href="#Creating-Maps">Creating Maps</a>.

32881

32882

</dd>

32883

<dt> Details:</dt>

32884

<dd>The syntax with neither premap nor width and height is useful in conjunction

32885

with <a href="#Map-Fusing">Map Fusing</a>.

32886

32887

A libmap-map is always rectangular. But you may use an ignore-key when you draw

32888

the map with <a href="#drawMap">drawMap</a> to create arbitrarily shaped areas.

32889

32890

If the premap is not rectangular, missing positions are set to the default key.

32891

However, each line length must be divisible by the default key’s length, otherwise

32892

an error is thrown.

32893

32894

You may feed arbitrary tables to <code>wo:newMap</code>, but only their positive

32895

integer entries are used, all other entries are ignored. You might even skip

32896

lines, like in this example:

32897

<table><tr><td> </td><td><pre class="example">wo:newMap(" ", {[25] = "g"})

32898

</pre></td></tr></table>

32899

This will return a map of width 1 and height 25 filled with spaces, except for

32900

the last line, which will be <code>"g"</code>.

32901

32902

Each libmap-map is a table and can be used as a premap as well. Its default

32903

key is ignored when a libmap-map is considered as a premap. In particular,

32904

you may use <code>wo:newMap</code> to copy a libmap-map with:

32905

<table><tr><td> </td><td><pre class="example">newcopy = wo:newMap(mymap.defaultkey, mymap)

32906

</pre></td></tr></table>

32907

</dd>

32908

</dl>

32909

32910

32911

32912

32913

32914

32915

32916

32917

32918

32919

32920

32921

32922

32923

32924

32925

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

32926

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

32927

32928

</tr></table>

32929

32930

<h3 class="subsection">12.4.8 Map Entry Request</h3>

32931

32932

32933

32934

You may request and set single entries within a libmap-map, using the

32935

index-operator ‘<samp>[]</samp>’.

32936

32937

32938

<dt> Syntax:</dt>

32939

<dd>entry = mymap[posarg]

32940

32941

entry = lib.map.get(mymap, posarg)

32942

32943

mymap[posarg] = newentry

32944

32945

lib.map.set(mymap, posarg, newentry)

32946

32947

32948

<dt> entry, newentry</dt>

32949

<dd>Non-empty strings of the same length as the default key of <code>mymap</code>.

32950

32951

</dd>

32952

<dt> mymap</dt>

32953

<dd>A libmap-map.

32954

32955

</dd>

32956

<dt> posarg</dt>

32957

<dd>A position, object, group, position list, string, or table (interpretable as

32958

single position).

32959

</dd>

32960

</dl>

32961

32962

</dd>

32963

<dt> Syntax Samples:</dt>

32964

<dd>See <a href="#Requesting-and-Changing-Single-Map-Entries">Requesting and Changing Single Map Entries</a>.

32965

32966

</dd>

32967

<dt> Details:</dt>

32968

<dd>A read-access with a group or position list will return a table of all key

32969

entries at the positions in the group or position list, in their corresponding

32970

sequence. Empty groups and position lists will return empty tables.

32971

32972

Correspondingly, a write-access with a group or position list changes the key

32973

at each position in the group or position list to the given string.

32974

32975

A read-access with a string invokes a <a href="#Positions-Repository-Request">Positions Repository Request</a> to

32976

retrieve a named position, unless the string equals one of <code>"type"</code>,

32977

<code>"width"</code>, <code>"height"</code>, <code>"defaultkey"</code>, or <code>"keylength"</code>,

32978

which return the corresponding properties of the map instead.

32979

32980

A write-access with a string similarly is interpreted as access to a named

32981

position, unless the string equals <code>"defaultkey"</code>, see

32982

<a href="#Map-Default-Keys">Map Default Keys</a>. A write-access to a non-existing position throws an

32983

error.

32984

32985

You may request any position outside of the scope of the map, even with

32986

negative coordinates. If you do so, the default key is returned. This accounts

32987

for non-existing positions as well (for example positions of items in the

32988

inventory, or the position of a string which doesn’t describe a named position).

32989

32990

If you try to set an entry to a position with a negative coordinate an error

32991

is returned. However, if you use non-negative coordinates outside of the scope

32992

of the map, the map is subsequently extended to the new position, setting

32993

the default key as entry where necessary.

32994

32995

Floating-point coordinates are always rounded to a grid position

32996

(see <a href="#Position-Grid-Rounding">Position Grid Rounding</a>).

32997

</dd>

32998

</dl>

32999

33000

33001

33002

33003

33004

33005

33006

33007

33008

33009

33010

33011

33012

33013

33014

33015

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

33016

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

33017

33018

</tr></table>

33019

33020

<h3 class="subsection">12.4.9 Map Transformation</h3>

33021

33022

33023

You may transform any libmap-map according to the eight map transformation

33024

constants given in <a href="#Rotating-and-Mirroring-Maps">Rotating and Mirroring Maps</a>.

33025

33026

33027

<dt> Syntax:</dt>

33028

<dd>newmap = mymap^maptransformation

33029

33030

newmap = lib.map.transform(mymap, maptransformation)

33031

33032

33033

<dt> mymap, newmap</dt>

33034

<dd>libmap-maps.

33035

33036

</dd>

33037

<dt> maptransformation</dt>

33038

<dd>One of the following eight constants: <code>MAP_IDENT</code>, <code>MAP_ROT_CW</code>,

33039

<code>MAP_ROT_180</code>, <code>MAP_ROT_CCW</code>, <code>MAP_FLIP_HORIZONTAL</code>,

33040

<code>MAP_FLIP_VERTICAL</code>, <code>MAP_FLIP_SLASH</code>, <code>MAP_FLIP_BACKSLASH</code>.

33041

</dd>

33042

</dl>

33043

33044

</dd>

33045

<dt> Syntax Samples:</dt>

33046

<dd>See <a href="#Rotating-and-Mirroring-Maps">Rotating and Mirroring Maps</a>.

33047

33048

</dd>

33049

<dt> Details:</dt>

33050

<dd>As map transformations can be composed with ‘<samp>^</samp>’, it is possible to combine

33051

several transformations without brackets; it’s only important to always have the

33052

map on the left side of the ‘<samp>^</samp>’-sign:

33053

<table><tr><td> </td><td><pre class="example">newmap = mymap ^ MAP_ROT_CW ^ MAP_FLIP_HORIZONTAL

33054

</pre></td></tr></table>

33055

However, each such combination can equally well be expressed with a single constant.

33056

33057

After a transformation, height and width of a map might have swapped.

33058

</dd>

33059

</dl>

33060

33061

33062

33063

33064

33065

33066

33067

33068

33069

33070

33071

33072

33073

33074

33075

33076

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

33077

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

33078

33079

</tr></table>

33080

33081

<h3 class="subsection">12.4.10 Map Horizontal Concatenation</h3>

33082

33083

33084

You may glue libmap-maps one after another in horizontal direction using

33085

‘<samp>..</samp>’. Note the similarity to the meaning of ‘<samp>..</samp>’ in the context of

33086

strings to remember its meaning in contrast to ‘<samp>+</samp>’ (see

33087

<a href="#Map-Vertical-Concatenation">Map Vertical Concatenation</a>).

33088

33089

33090

<dt> Syntax:</dt>

33091

<dd>newmap = mymap1 .. mymap2

33092

33093

newmap = lib.map.concat_horizontally(mymap1, mymap2)

33094

33095

33096

<dt> mymap1, mymap2, newmap</dt>

33097

<dd>libmap-maps.

33098

</dd>

33099

</dl>

33100

33101

</dd>

33102

<dt> Syntax Samples:</dt>

33103

<dd>See <a href="#Connecting-Two-Maps">Connecting Two Maps</a>.

33104

33105

</dd>

33106

<dt> Details:</dt>

33107

<dd>The upper-left corner of the second map is set beneath the upper-right corner

33108

of the first, i.e. the bottom lines of the maps are aligned. If you want to

33109

align them in another way, you may first vertically concat a map of suitable

33110

height to the second (or first) map, like in this example:

33111

<table><tr><td> </td><td><pre class="example">newmap = mymap1 .. (wo:newMap(" ", 1, 13) + mymap2)

33112

</pre></td></tr></table>

33113

33114

The default key of the new map is the default key of the first map. Any missing

33115

position to gain a rectangular map is subsequently set to this default key.

33116

</dd>

33117

</dl>

33118

33119

33120

33121

33122

33123

33124

33125

33126

33127

33128

33129

33130

33131

33132

33133

33134

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

33135

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

33136

33137

</tr></table>

33138

33139

<h3 class="subsection">12.4.11 Map Vertical Concatenation</h3>

33140

33141

33142

You may glue libmap-maps on top of each other in vertical direction using

33143

‘<samp>+</samp>’. Compare with the meaning of ‘<samp>..</samp>’ (see

33144

<a href="#Map-Horizontal-Concatenation">Map Horizontal Concatenation</a>).

33145

33146

33147

<dt> Syntax:</dt>

33148

<dd>newmap = mymap1 + mymap2

33149

33150

newmap = lib.map.concat_vertically(mymap1, mymap2)

33151

33152

33153

<dt> mymap1, mymap2, newmap</dt>

33154

<dd>libmap-maps.

33155

</dd>

33156

</dl>

33157

33158

</dd>

33159

<dt> Syntax Samples:</dt>

33160

<dd>See <a href="#Connecting-Two-Maps">Connecting Two Maps</a>.

33161

33162

</dd>

33163

<dt> Details:</dt>

33164

<dd>The upper-left corner of the second map is set below the lower-left corner

33165

of the first, i.e. the left borders of the maps are aligned. If you want to

33166

align them in another way, you may first horizontally concat a map of suitable

33167

width to the second (or first) map, like in this example:

33168

<table><tr><td> </td><td><pre class="example">newmap = mymap1 + (wo:newMap(" ", 13, 1) .. mymap2)

33169

</pre></td></tr></table>

33170

33171

The default key of the new map is the default key of the first map. Any missing

33172

position to gain a rectangular map is subsequently set to this default key.

33173

</dd>

33174

</dl>

33175

33176

33177

33178

33179

33180

33181

33182

33183

33184

33185

33186

33187

33188

33189

33190

33191

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

33192

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

33193

33194

</tr></table>

33195

33196

<h3 class="subsection">12.4.12 Map Fusing</h3>

33197

33198

33199

You may fuse libmap-maps in the way described in <a href="#Connecting-Two-Maps">Connecting Two Maps</a>, by

33200

interpreting the two keys of the two maps at a position as parts of a combined

33201

(fused) key at this position.

33202

33203

33204

<dt> Syntax:</dt>

33205

<dd>newmap = mymap1 * mymap2

33206

33207

newmap = lib.map.fuse(mymap1, mymap2)

33208

33209

33210

<dt> mymap1, mymap2, newmap</dt>

33211

<dd>libmap-maps.

33212

</dd>

33213

</dl>

33214

33215

</dd>

33216

<dt> Syntax Samples:</dt>

33217

<dd>See <a href="#Connecting-Two-Maps">Connecting Two Maps</a>.

33218

33219

</dd>

33220

<dt> Details:</dt>

33221

<dd>Missing keys in one map are replaced by the default key of this map.

33222

33223

The default key of the result is the concatenation of the default key of the

33224

first map with the default key of the second map (as expected).

33225

33226

The inverse of the fusing operation is given by <a href="#lib_002emap_002edefuse">lib.map.defuse</a>.

33227

33228

One of the maps is allowed to be a string, which is then interpreted as a

33229

1x1-map with the given string as default key. The result of the fusing process

33230

then is that each tile key is concatenated with the given string.

33231

</dd>

33232

</dl>

33233

33234

33235

33236

33237

33238

33239

33240

33241

33242

33243

33244

33245

33246

33247

33248

33249

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

33250

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

33251

33252

</tr></table>

33253

33254

<h3 class="subsection">12.4.13 Map Default Keys</h3>

33255

33256

33257

A libmap-map always includes a default key, which is used in various places

33258

throughout the library. It is the placeholder whenever a key out of scope of

33259

the map is requested, or when <a href="#drawMap">drawMap</a> or <code>wo</code> (see

33260

<a href="#World-Creation">World Creation</a>) are invoked without a default or ignore key. Hence, it is

33261

sometimes necessary to retrieve or change the default key of a map.

33262

33263

33264

<dt> Syntax:</dt>

33265

<dd>defaultkey = mymap.defaultkey

33266

33267

defaultkey = mymap["defaultkey"]

33268

33269

keylength = mymap.keylength

33270

33271

keylength = mymap["keylength"]

33272

33273

mymap.defaultkey = newkey

33274

33275

mymap["defaultkey"] = newkey

33276

33277

mymap:set_default_key(newkey)

33278

33279

lib.map.set_default_key(mymap, newkey)

33280

33281

33282

<dt> defaultkey, newkey</dt>

33283

<dd>A non-empty string.

33284

33285

</dd>

33286

<dt> mymap</dt>

33287

<dd>A libmap-map.

33288

33289

</dd>

33290

<dt> keylength</dt>

33291

<dd>A positive integer, which equals the length of the default key.

33292

</dd>

33293

</dl>

33294

33295

</dd>

33296

<dt> Syntax Samples:</dt>

33297

<dd>See <a href="#Other-Map-Tasks">Other Map Tasks</a>.

33298

33299

</dd>

33300

<dt> Details:</dt>

33301

<dd>It typically makes sense to change the default key of a map, when two or more

33302

keys can be equally well thought of as being "default". Such an example occurs

33303

during the import of Sokoban levels: While the canonical default key would be

33304

the key of the inner free tiles, it is temporarily set to the key of the outer

33305

area to allow a simple matching and trimming. It is then set back again:

33306

<table><tr><td> </td><td><pre class="example">local map = lib.import.level_to_map(level, "\n", " ")

33307

map:replace("_")

33308

map:replace("-")

33309

map:replace_outside(" ", "-")

33310

-- Remove redundant walls by outside:

33311

-- A wall is redundant, if it is surrounded by "-" or "#".

33312

-- In this case, it can be replaced by "-".

33313

map.defaultkey = "-"

33314

map[map:match({{po(0,0), "#"}, {NEIGHBORS_8, "-", "#"}})] = "-"

33315

map = map:trim()

33316

map.defaultkey = " "

33317

</pre></td></tr></table>

33318

See <a href="#lib_002emap_002ematch">lib.map.match</a> and <a href="#lib_002emap_002etrim">lib.map.trim</a> for details on their use of

33319

default keys.

33320

33321

The keylength of a map can be read, but not written. To change the keylength,

33322

a new default key has to be assigned. On the other hand, it is possible to

33323

change the default key to a key of different length; however, this rarely makes

33324

sense, as each line will be reinterpreted, and the width of the map changes.

33325

Still, the width has to fit to the new keylength, otherwise an error is

33326

thrown.

33327

33328

If you want to change the keylength without reinterpreting each line, you

33329

should instead fuse or defuse the map (see <a href="#Map-Fusing">Map Fusing</a>,

33330

<a href="#lib_002emap_002edefuse">lib.map.defuse</a>). <a href="#newMap">newMap</a> allows this quite easily:

33331

<table><tr><td> </td><td><pre class="example">extendedmap = mymap * wo:newMap(" ")

33332

restrictedmap = (mymap:defuse())[1] * (mymap:defuse())[3]

33333

</pre></td></tr></table>

33334

</dd>

33335

</dl>

33336

33337

33338

33339

33340

33341

33342

33343

33344

33345

33346

33347

33348

33349

33350

33351

33352

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

33353

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

33354

33355

</tr></table>

33356

33357

<h3 class="subsection">12.4.14 Map Width and Height</h3>

33358

33359

A libmap-map always includes its width and height. These determine for example

33360

the exact position of the second map during a concatenation (see

33361

<a href="#Connecting-Two-Maps">Connecting Two Maps</a>).

33362

33363

33364

<dt> Syntax:</dt>

33365

<dd>width = mymap.width

33366

33367

width = mymap["width"]

33368

33369

height = mymap.height

33370

33371

height = mymap["height"]

33372

33373

33374

<dt> width, height</dt>

33375

<dd>Positive integers.

33376

33377

</dd>

33378

<dt> mymap</dt>

33379

<dd>A libmap-map.

33380

</dd>

33381

</dl>

33382

33383

</dd>

33384

<dt> Details:</dt>

33385

<dd>See also <a href="#Other-Map-Tasks">Other Map Tasks</a>.

33386

33387

It is not possible (and rarely necessary) to directly change width and height

33388

of a map. Instead, you might use <a href="#lib_002emap_002eextend">lib.map.extend</a> to extend a map to a

33389

given position, <a href="#lib_002emap_002esub">lib.map.sub</a> to retrieve a rectangular part of a map, or

33390

<a href="#lib_002emap_002etrim">lib.map.trim</a> to remove unused lines and columns from the map.

33391

33392

Note that width and height are not invariant. They change with many operations,

33393

like transformations, concatenations or setting a key outside the former scope

33394

of a map.

33395

33396

Also note that the upper-left corner of a map has coordinates <code>{0, 0}</code>,

33397

so the lower-right corner is <code>{width - 1, height - 1}</code>.

33398

</dd>

33399

</dl>

33400

33401

33402

33403

33404

33405

33406

33407

33408

33409

33410

33411

33412

33413

33414

33415

33416

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

33417

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

33418

33419

</tr></table>

33420

33421

<h3 class="subsection">12.4.15 lib.map.covers</h3>

33422

33423

33424

<code>covers</code> checks whether a position is within the scope of a map.

33425

33426

33427

<dt> Syntax:</dt>

33428

<dd>result = mymap:covers(position)

33429

33430

result = lib.map.covers(mymap, position)

33431

33432

33433

<dt> result</dt>

33434

<dd>A boolean value: <code>true</code>, if position is within the rectangle of grids

33435

spanned by <code>(0,0)</code> and <code>(mymap.width - 1, mymap.height - 1)</code>,

33436

otherwise <code>false</code>.

33437

33438

</dd>

33439

<dt> mymap</dt>

33440

<dd>A libmap-map.

33441

33442

</dd>

33443

<dt> position</dt>

33444

<dd>A positional value (position or table with two entries).

33445

</dd>

33446

</dl>

33447

33448

</dd>

33449

<dt> Syntax Samples:</dt>

33450

<dd><table><tr><td> </td><td><pre class="example">if map1:covers(po(no["mycoin"]) - po(no["anchor1"])) then

33451

wo(no["mycoin"]) = ti["-"]

33452

end

33453

</pre></td></tr></table>

33454

33455

</dd>

33456

<dt> Details:</dt>

33457

<dd>Floating-point positions are handled as expected, i.e. the position of a marble

33458

which is on a grid corresponding to the map lets <code>cover</code> return

33459

<code>true</code>.

33460

33461

Remember to subtract the anchor of an already drawn map to get the correct

33462

information when you use positions of the level world.

33463

</dd>

33464

</dl>

33465

33466

33467

33468

33469

33470

33471

33472

33473

33474

33475

33476

33477

33478

33479

33480

33481

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

33482

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

33483

33484

</tr></table>

33485

33486

<h3 class="subsection">12.4.16 lib.map.defuse</h3>

33487

33488

33489

<code>defuse</code> returns a table of maps of keylength one, which correspond to the

33490

first, second, n-th character of each key at each position, respectively.

33491

33492

33493

<dt> Syntax:</dt>

33494

<dd>result = mymap:defuse()

33495

33496

result = lib.map.defuse(mymap)

33497

33498

33499

<dt> result</dt>

33500

<dd>A non-empty table with maps as entries at integer positions. There are as many

33501

maps as the keylength of <code>mymap</code>.

33502

33503

</dd>

33504

<dt> mymap</dt>

33505

<dd>A libmap-map.

33506

</dd>

33507

</dl>

33508

33509

</dd>

33510

<dt> Full Example:</dt>

33511

<dd>Given the following map,

33512

<table><tr><td> </td><td><pre class="example">mymap = wo:newMap(" .", {"#C# # # # # #C",

33513

"# w1.1# .2.2# ",

33514

"# .1.1D3.2.2# ",

33515

"# .1.1# .2w2# ",

33516

"#C# # # # # #C"})

33517

</pre></td></tr></table>

33518

<code>mymap:defuse()</code> will return a table

33519

<table><tr><td> </td><td><pre class="example">result = {map1, map2}

33520

</pre></td></tr></table>

33521

containing the following two maps:

33522

<table><tr><td> </td><td><pre class="example">map1 = wo:newMap(".", {"#######",

33523

"#w.#..#",

33524

"#..D..#",

33525

"#..#.w#",

33526

"#######"})

33527

map2 = wo:newMap(".", {"C C",

33528

" 11 22 ",

33529

" 11322 ",

33530

" 11 22 ",

33531

"C C"})

33532

</pre></td></tr></table>

33533

33534

</dd>

33535

<dt> Details:</dt>

33536

<dd>The default keys of the defused maps are the single characters of the default

33537

key, in corresponding sequence.

33538

33539

The inverse of defusing is <a href="#Map-Fusing">Map Fusing</a>.

33540

</dd>

33541

</dl>

33542

33543

33544

33545

33546

33547

33548

33549

33550

33551

33552

33553

33554

33555

33556

33557

33558

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

33559

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

33560

33561

</tr></table>

33562

33563

<h3 class="subsection">12.4.17 lib.map.extend</h3>

33564

33565

33566

<code>extend</code> changes a map in-place such that it covers a given position. If

33567

the position already is within the scope of the map, nothing happens.

33568

33569

33570

<dt> Syntax:</dt>

33571

<dd>mymap:extend(position)

33572

33573

lib.map.extend(mymap, position)

33574

33575

33576

<dt> mymap</dt>

33577

<dd>A libmap-map.

33578

33579

</dd>

33580

<dt> position</dt>

33581

<dd>A positional value (position, table with two entries, valid object, or string).

33582

</dd>

33583

</dl>

33584

33585

</dd>

33586

<dt> Syntax Samples:</dt>

33587

<dd><table><tr><td> </td><td><pre class="example">mymap:extend(po(no["mycoin1"]) - po(no["anchor1"]))

33588

mymap:extend("secondanchor")

33589

</pre></td></tr></table>

33590

33591

</dd>

33592

<dt> Details:</dt>

33593

<dd>Negative coordinates are silently ignored. However, if the other coordinate

33594

makes sense, the map might still get extended.

33595

33596

Floating-point coordinates are rounded to a grid position

33597

(see <a href="#Position-Grid-Rounding">Position Grid Rounding</a>).

33598

</dd>

33599

</dl>

33600

33601

33602

33603

33604

33605

33606

33607

33608

33609

33610

33611

33612

33613

33614

33615

33616

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

33617

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

33618

33619

</tr></table>

33620

33621

<h3 class="subsection">12.4.18 lib.map.match</h3>

33622

33623

33624

You may use <code>match</code> to search for patterns or keys within a map.

33625

<code>match</code> then returns a position list of grid positions.

33626

33627

33628

<dt> Syntax:</dt>

33629

<dd>result = mymap:match()

33630

33631

result = mymap:match(tilekey)

33632

33633

result = mymap:match(conditionlist)

33634

33635

result = mymap:match({conditionlist})

33636

33637

result = lib.map.match(mymap, conditionlist)

33638

33639

33640

<dt> result</dt>

33641

<dd>The position list of all matched positions.

33642

33643

</dd>

33644

<dt> mymap</dt>

33645

<dd>A libmap-map.

33646

33647

</dd>

33648

<dt> conditionlist = condition, condition, ...</dt>

33649

<dd>A list of conditions. A position is matched if and only if all conditions of the

33650

conditionlist are matched.

33651

33652

</dd>

33653

<dt> condition = {positionlist, tilekey, tilekey, ...}</dt>

33654

<dd>A position <code>pos</code> is matched by this condition if and only if for each position

33655

<code>relativepos</code> in <code>positionlist</code> the tilekey

33656

<code>mymap[pos + relativepos]</code> equals one of the tilekeys in the list. If

33657

<code>pos + relativepos</code> is outside the scope of mymap, its tilekey is the

33658

default key.

33659

33660

</dd>

33661

<dt> tilekey</dt>

33662

<dd>Non-empty string of the same length as the default key of <code>mymap</code>

33663

(no wildcards).

33664

33665

</dd>

33666

<dt> positionlist</dt>

33667

<dd>A single relative position or a position list of relative positions.

33668

</dd>

33669

</dl>

33670

33671

</dd>

33672

<dt> Full Example:</dt>

33673

<dd>Given the following map,

33674

<table><tr><td> </td><td><pre class="example">mymap = wo:newMap(" ", {"#####",

33675

"#w# #",

33676

"# D #",

33677

"# #w#",

33678

"#####"})

33679

</pre></td></tr></table>

33680

<code>mymap:match("#")</code> will return a position list of all walls <code>"#"</code>, it

33681

is identical to <code>mymap:match({po(0, 0), "#"})</code> and

33682

<code>mymap:match({{po(0, 0), "#"}})</code>.

33683

33684

We may search for all positions <code>pos</code> which are between two walls with:

33685

<table><tr><td> </td><td><pre class="example">result = mymap:match({po(-1, 0), "#"}, {po(1, 0), "#"})

33686

</pre></td></tr></table>

33687

The two positions <code>po(-1, 0)</code> and <code>po(1, 0)</code> are relative to the

33688

returned position. This returns a position list including positions like the

33689

wall at <code>{1,0}</code> (which indeed is between two walls at <code>po(1, 0) +

33690

po(-1, 0)</code> and <code>po(1, 0) + po(1, 0)</code>), but also <code>{1,1}</code>. If we want

33691

to exclude walls at our position, we have to give all other keys instead:

33692

<table><tr><td> </td><td><pre class="example">result = mymap:match({po(-1, 0), "#"}, {po(1, 0), "#"}, {po(0, 0), "w", " ", "D"})

33693

</pre></td></tr></table>

33694

33695

Finally, <code>mymap:match()</code> will return all positions of the map, i.e. a

33696

position list with all positions between <code>{0,0}</code> and

33697

<code>{mymap.width - 1, mymap.height - 1}</code>.

33698

33699

See also <a href="#Requesting-and-Changing-Single-Map-Entries">Requesting and Changing Single Map Entries</a>.

33700

33701

</dd>

33702

<dt> Details:</dt>

33703

<dd>You can, but need not pack the condition list <code>match</code> into a single table.

33704

This possibility exists to easily work with automatically generated condition

33705

lists, but should be avoided in other cases due to readability.

33706

33707

The result of <code>match</code> is sorted primarily vertical, and secondarily

33708

horizontal, i.e. a typical result would be:

33709

<table><tr><td> </td><td><pre class="example">po(1, 1) .. po(1, 3) .. po(1, 4) .. po(2, 2) .. po(2, 3) .. po(5, 1)

33710

</pre></td></tr></table>

33711

33712

If you feed the position list back into a replacing command, like in

33713

<table><tr><td> </td><td><pre class="example">mymap = wo:newMap(" ", {"####",

33714

"# #",

33715

"####"})

33716

mymap[mymap:match({NEIGHBORS_8, "#"})] = "#"

33717

</pre></td></tr></table>

33718

remember that the newly added changes could not be respected by the

33719

<code>match</code>; so in the above example, the match returns an empty position list

33720

and no tilekey is subsequently replaced.

33721

33722

Floating-point coordinates are rounded to a grid position

33723

(see <a href="#Position-Grid-Rounding">Position Grid Rounding</a>).

33724

</dd>

33725

</dl>

33726

33727

33728

33729

33730

33731

33732

33733

33734

33735

33736

33737

33738

33739

33740

33741

33742

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

33743

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

33744

33745

</tr></table>

33746

33747

<h3 class="subsection">12.4.19 lib.map.paste</h3>

33748

33749

33750

<code>paste</code> copies a map into another map at a given position. This command

33751

works in-place, i.e. the receiving map is changed, instead of returning a new map.

33752

33753

33754

<dt> Syntax:</dt>

33755

<dd>map1:paste(map2, position)

33756

33757

lib.map.paste(map1, map2, position)

33758

33759

33760

33761

<dd>The libmap-map to receive the copy.

33762

33763

</dd>

33764

33765

<dd>The libmap-map which is to be copied into <code>map1</code>.

33766

33767

</dd>

33768

<dt> position</dt>

33769

<dd>A positional value (position, table with two entries, valid object, position

33770

list, group, or string). The upper-left position <code>{0, 0}</code> of <code>map2</code>

33771

is inserted at this position (or these positions) into <code>map1</code>.

33772

</dd>

33773

</dl>

33774

33775

</dd>

33776

<dt> Full Example:</dt>

33777

<dd><table><tr><td> </td><td><pre class="example">map1 = wo:newMap(" ", {"#######",

33778

"#w # #",

33779

"# D #",

33780

"# # w#",

33781

"#######"})

33782

map2 = wo:newMap(".", {"F.E",

33783

"E.E"})

33784

</pre></td></tr></table>

33785

In this situation, <code>map1:paste(map2, po(1, 1) .. po(5, 3))</code> will change

33786

map1 into:

33787

<table><tr><td> </td><td><pre class="example">{"####### ",

33788

"#F E # ",

33789

"#E E # ",

33790

"# # F#E",

33791

"#####E#E"}

33792

</pre></td></tr></table>

33793

33794

</dd>

33795

<dt> Details:</dt>

33796

<dd>The receiving map will be extended with its default key as necessary.

33797

33798

Each tilekey of the copied map which equals its default key will be ignored

33799

during the pasting process.

33800

33801

Floating-point coordinates are rounded to a grid position

33802

(see <a href="#Position-Grid-Rounding">Position Grid Rounding</a>).

33803

33804

If a part of a map is to be copied to a position with negative coordinates, an

33805

error is thrown. However, if this part is to be ignored anyway (because it is

33806

the default key), then the negative coordinate is silently ignored.

33807

If for example we have

33808

<table><tr><td> </td><td><pre class="example">map1 = wo:newMap(" ", {"#######",

33809

"#w # #",

33810

"# D #",

33811

"# # w#",

33812

"#######"})

33813

map2 = wo:newMap(".", {".FE",

33814

".EE"})

33815

</pre></td></tr></table>

33816

then <code>map1:paste(map2, po(-1, 0))</code> will change

33817

map1 into

33818

<table><tr><td> </td><td><pre class="example">{"FE#####",

33819

"EE # #",

33820

"# D #",

33821

"# # #",

33822

"#######"}

33823

</pre></td></tr></table>

33824

while <code>map1:paste(map2, po(0, -1))</code> throws an error.

33825

33826

A map can be pasted multiple times into another map by providing a position

33827

list or object group. The sequence of pastings is then given by the sequence of

33828

the list or group, so the pasting at the second entry might overwrite the

33829

changes done by the first entry.

33830

</dd>

33831

</dl>

33832

33833

33834

33835

33836

33837

33838

33839

33840

33841

33842

33843

33844

33845

33846

33847

33848

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

33849

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

33850

33851

</tr></table>

33852

33853

<h3 class="subsection">12.4.20 lib.map.print</h3>

33854

33855

33856

<code>print</code> prints a map to standard output. You may use this command for

33857

debugging purposes, or to support development or translation of a level, but it

33858

should not be used in the released form of a level.

33859

33860

33861

<dt> Syntax:</dt>

33862

<dd>mymap:print([withXYCounts [, left_separator [, right_separator]]])

33863

33864

lib.map.print(mymap [, withXYCounts [, left_separator [, right_separator]]])

33865

33866

33867

<dt> mymap</dt>

33868

<dd>A libmap-map.

33869

33870

</dd>

33871

<dt> withXYCounts</dt>

33872

<dd>A boolean value, <code>false</code> by default.

33873

33874

</dd>

33875

<dt> left_separator, right_separator</dt>

33876

<dd>Strings to be printed on the left and on the right side of the map, empty

33877

strings by default.

33878

</dd>

33879

</dl>

33880

33881

</dd>

33882

<dt> Full Example:</dt>

33883

<dd><table><tr><td> </td><td><pre class="example">mymap = wo:newMap(" ", {"#######",

33884

"#w # #",

33885

"# D #",

33886

"# # w#",

33887

"#######"})

33888

</pre></td></tr></table>

33889

Then <code>mymap:print(true, " -> ", "|")</code> prints the following to standard output:

33890

<table><tr><td> </td><td><pre class="example"> -> 0123456|

33891

0 -> #######|

33892

1 -> #w # #|

33893

2 -> # D #|

33894

3 -> # # w#|

33895

4 -> #######|

33896

</pre></td></tr></table>

33897

33898

</dd>

33899

<dt> Details:</dt>

33900

<dd>If you use maps wider than ten times its keylength, the x-count will show

33901

only the last digits of the x coordinate.

33902

33903

If you want to insert lines between the columns, you can fuse the map

33904

with your desired character, like in <code>(mymap * "|"):print(...)</code>.

33905

33906

You can actually use <code>print</code> to generate a map for a level file if you

33907

provide appropriate separators:

33908

<table><tr><td> </td><td><pre class="example">mymap:print(false, " \"", "\",")

33909

</pre></td></tr></table>

33910

</dd>

33911

</dl>

33912

33913

33914

33915

33916

33917

33918

33919

33920

33921

33922

33923

33924

33925

33926

33927

33928

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

33929

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

33930

33931

</tr></table>

33932

33933

<h3 class="subsection">12.4.21 lib.map.replace</h3>

33934

33935

33936

<code>replace</code> replaces all occurrences of a single tile key in a map in-place

33937

with another tile key.

33938

33939

33940

<dt> Syntax:</dt>

33941

<dd>mymap:replace(oldkey [, newkey])

33942

33943

lib.map.replace(mymap, oldkey [, newkey])

33944

33945

33946

<dt> mymap</dt>

33947

<dd>A libmap-map.

33948

33949

</dd>

33950

<dt> oldkey</dt>

33951

<dd>A non-empty string of the same length as <code>mymap</code>’s default key.

33952

33953

</dd>

33954

<dt> newkey</dt>

33955

<dd>A non-empty string of the same length as <code>mymap</code>’s default key, which is the

33956

replacement for <code>oldkey</code>. The default replacement key is the default key itself.

33957

</dd>

33958

</dl>

33959

33960

</dd>

33961

<dt> Syntax Samples:</dt>

33962

<dd><table><tr><td> </td><td><pre class="example">mymap:replace("#", "-")

33963

</pre></td></tr></table>

33964

will change <code>mymap</code> in such a way that each <code>"#"</code> is replaced by

33965

<code>"-"</code>. If <code>"-"</code> is omitted, each <code>"#"</code> is replaced by the

33966

default key instead.

33967

33968

</dd>

33969

<dt> Details:</dt>

33970

<dd>‘<samp>mymap:replace(tile1, tile2)</samp>’ is equivalent to

33971

<table><tr><td> </td><td><pre class="example">mymap[mymap:match(tile1)] = tile2 or mymap.defaultkey

33972

</pre></td></tr></table>

33973

but faster, because no position list is constructed in between (see

33974

<a href="#lib_002emap_002ematch">lib.map.match</a>).

33975

33976

See also <a href="#lib_002emap_002ereplace_005foutside">lib.map.replace_outside</a> and

33977

<a href="#Requesting-and-Changing-Single-Map-Entries">Requesting and Changing Single Map Entries</a>.

33978

</dd>

33979

</dl>

33980

33981

33982

33983

33984

33985

33986

33987

33988

33989

33990

33991

33992

33993

33994

33995

33996

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

33997

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

33998

33999

</tr></table>

34000

34001

<h3 class="subsection">12.4.22 lib.map.replace_outside</h3>

34002

34003

34004

<code>replace_outside</code> is a very specialized command, which is used to replace

34005

all occurrences of a tile key which are connected to the border of the map by a

34006

path of this tile key with another tile key. The replacement is done in-place,

34007

i.e. no new map is created or returned.

34008

34009

34010

<dt> Syntax:</dt>

34011

<dd>mymap:replace_outside(oldkey [, newkey])

34012

34013

lib.map.replace_outside(mymap, oldkey [, newkey])

34014

34015

34016

<dt> mymap</dt>

34017

<dd>A libmap-map.

34018

34019

</dd>

34020

<dt> oldkey</dt>

34021

<dd>A non-empty string of the same length as <code>mymap</code>’s default key.

34022

34023

</dd>

34024

<dt> newkey</dt>

34025

<dd>A non-empty string of the same length as <code>mymap</code>’s default key, which is the

34026

replacement for <code>oldkey</code>. The default replacement key is the default key itself.

34027

</dd>

34028

</dl>

34029

34030

</dd>

34031

<dt> Syntax Samples:</dt>

34032

<dd>See <a href="#Other-Map-Tasks">Other Map Tasks</a>.

34033

34034

</dd>

34035

<dt> Details:</dt>

34036

<dd><code>replace_outside</code> shows similarities with <a href="#lib_002emap_002ereplace">lib.map.replace</a> and

34037

<a href="#lib_002emap_002etrim">lib.map.trim</a>. It is the only universal way to handle the area near

34038

the border of a map, and can be combined with <a href="#lib_002emap_002ematch">lib.map.match</a> and

34039

<a href="#lib_002emap_002etrim">lib.map.trim</a> to show its full potential.

34040

34041

Because of its recursive nature, old and new tile key must be different; in

34042

contrast to the situation of <a href="#lib_002emap_002ereplace">lib.map.replace</a> identical tile keys are not

34043

silently ignored, but throw an error message.

34044

</dd>

34045

</dl>

34046

34047

34048

34049

34050

34051

34052

34053

34054

34055

34056

34057

34058

34059

34060

34061

34062

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

34063

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

34064

34065

</tr></table>

34066

34067

34068

34069

34070

<code>sub</code> returns a copy of a rectangular section of a map as a new map.

34071

34072

34073

<dt> Syntax:</dt>

34074

<dd>submap = mymap:sub(upperleft, lowerright)

34075

34076

submap = mymap:sub(upperleft, width, height)

34077

34078

submap = lib.map.sub(mymap, upperleft, lowerright)

34079

34080

submap = lib.map.sub(mymap, upperleft, width, height)

34081

34082

34083

<dt> submap</dt>

34084

<dd>A libmap-map, the rectangular section of <code>mymap</code>.

34085

34086

</dd>

34087

<dt> mymap</dt>

34088

<dd>A libmap-map.

34089

34090

</dd>

34091

<dt> upperleft, lowerright</dt>

34092

<dd>Positional values (position, valid object, table with two entries, or name of a

34093

named position.

34094

34095

</dd>

34096

<dt> width, height</dt>

34097

<dd>Positive integers.

34098

</dd>

34099

</dl>

34100

34101

</dd>

34102

<dt> Syntax Samples:</dt>

34103

<dd>See <a href="#Other-Map-Tasks">Other Map Tasks</a>.

34104

34105

</dd>

34106

<dt> Details:</dt>

34107

<dd>If the bottom right-hand corner overlaps the area of <code>mymap</code>, the resulting

34108

<code>submap</code> will still be just the rectangular section of <code>mymap</code>, i.e.

34109

width and height can be less than the arguments specified. Use

34110

<code>submap:extend(width, height)</code> to ensure the full width and height.

34111

34112

Floating point positions are rounded to grid positions, and the lower-right

34113

corner may not have coordinates less than those of the upper-left corner,

34114

otherwise an error is thrown.

34115

34116

The default key of the submap is the default key of the original map.

34117

34118

The upper-left corner of the submap of course is <code>{0,0}</code>, i.e. the

34119

coordinates are shifted accordingly.

34120

</dd>

34121

</dl>

34122

34123

34124

34125

34126

34127

34128

34129

34130

34131

34132

34133

34134

34135

34136

34137

34138

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

34139

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

34140

34141

</tr></table>

34142

34143

34144

34145

34146

<code>trim</code> returns the smallest rectangular section of a map as new map such

34147

that its border consists of a given tile key only, i.e. it trims the original

34148

map from the North, East, South, and West.

34149

34150

34151

<dt> Syntax:</dt>

34152

<dd>trimmedmap = mymap:trim([tilekey])

34153

34154

trimmedmap = lib.map.trim(mymap [, tilekey])

34155

34156

34157

<dt> trimmedmap</dt>

34158

<dd>A libmap-map, the trimmed copy of <code>mymap</code>.

34159

34160

</dd>

34161

<dt> mymap</dt>

34162

<dd>A libmap-map.

34163

34164

</dd>

34165

<dt> tilekey</dt>

34166

<dd>A non-empty string of the same length as the default key. If omitted, the

34167

default key is used instead.

34168

</dd>

34169

</dl>

34170

34171

</dd>

34172

<dt> Full Example:</dt>

34173

<dd>With the following map:

34174

<table><tr><td> </td><td><pre class="example">mymap = wo:newMap(" ", {"#######",

34175

"#w # #",

34176

"# D #",

34177

"# # w#",

34178

"#######"})

34179

</pre></td></tr></table>

34180

Trimming with ‘<samp>mymap:trim()</samp>’ will return just a copy of the original map,

34181

but ‘<samp>mymap:trim("#")</samp>’ returns a map as follows:

34182

<table><tr><td> </td><td><pre class="example">{"w # ",

34183

" D ",

34184

" # w"})

34185

</pre></td></tr></table>

34186

34187

</dd>

34188

<dt> Details:</dt>

34189

<dd>The default key of the trimmed map is the default key of the original map.

34190

34191

If the original map consists of the trimmed key only, then <code>trim</code> returns

34192

a 1x1-map with the trimmed key as only entry, and the default key of the

34193

original map.

34194

</dd>

34195

</dl>

34196

34197

34198

34199

34200

34201

34202

34203

34204

34205

34206

34207

34208

34209

34210

34211

34212

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

34213

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

34214

34215

</tr></table>

34216

34217

<h3 class="subsection">12.4.25 Map Transformation Index and MAP_ALL</h3>

34218

34219

All eight transformation constants (see <a href="#map-read-directions">map read directions</a>,

34220

<a href="#Rotating-and-Mirroring-Maps">Rotating and Mirroring Maps</a>, <a href="#Map-Transformation">Map Transformation</a>) are additionally

34221

packed into the table <code>MAP_ALL</code>, so a simple call to

34222

<code>ipairs(MAP_ALL)</code> can iterate over all of them. <code>MAP_ALL</code> is provided

34223

without need to load libmap.

34224

34225

Each transformation offers the field <code>"index"</code>, which returns the number at

34226

which the transformation appears in <code>MAP_ALL</code>. libmap is not needed to use

34227

<code>"index"</code> either.

34228

34229

34230

<dt> Syntax:</dt>

34231

<dd>MAP_ALL = {MAP_IDENT, MAP_ROT_CW, MAP_ROT_180, MAP_ROT_CCW, MAP_FLIP_BACKSLASH,

34232

MAP_FLIP_HORIZONTAL, MAP_FLIP_SLASH, MAP_FLIP_VERTICAL}

34233

34234

transformation_index = maptransformation.index

34235

34236

34237

<dt> transformation_index</dt>

34238

<dd>An integer between 1 and 8.

34239

34240

</dd>

34241

<dt> maptransformation</dt>

34242

<dd>A map transformation.

34243

</dd>

34244

</dl>

34245

34246

</dd>

34247

<dt> Syntax Samples:</dt>

34248

<dd><table><tr><td> </td><td><pre class="example">MAP_ALL[MAP_ROT_CW.index] == MAP_ROT_CW

34249

</pre></td></tr></table>

34250

34251

</dd>

34252

<dt> Details:</dt>

34253

<dd>You may not safe map transformations as attributes of objects, for example the

34254

following will throw an error:

34255

<table><tr><td> </td><td><pre class="example">no["stone_a"]["_mytrafo"] = MAP_ROT_CCW

34256

</pre></td></tr></table>

34257

Instead, you have to use <code>index</code> and retrieve the correct transformation

34258

from <code>MAP_ALL</code>:

34259

<table><tr><td> </td><td><pre class="example">no["stone_a"]["_mytrafo"] = MAP_ROT_CCW.index

34260

...

34261

oldtrafo = MAP_ALL[no["stone_a"]["_mytrafo"]]

34262

</pre></td></tr></table>

34263

</dd>

34264

</dl>

34265

34266

34267

34268

34269

34270

34271

34272

34273

34274

34275

34276

34277

34278

34279

34280

34281

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

34282

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

34283

34284

</tr></table>

34285

34286

<h3 class="subsection">12.4.26 Map Transformation Composition and Powers</h3>

34287

34288

34289

34290

The transformation constants (see <a href="#map-read-directions">map read directions</a>,

34291

<a href="#Rotating-and-Mirroring-Maps">Rotating and Mirroring Maps</a>, <a href="#Map-Transformation">Map Transformation</a>) can be composed

34292

according to their true operation on a map, as soon as libmap is loaded. The

34293

composition is returned by the operations ‘<samp>*</samp>’ and ‘<samp>^</samp>’.

34294

34295

34296

<dt> Syntax:</dt>

34297

<dd>composition = maptransformation1 * maptransformation2

34298

34299

composition = maptransformation1 ^ maptransformation2

34300

34301

composition = lib.map.transformation_compose(maptransformation1, maptransformation2)

34302

34303

composition = lib.map.transformation_power(maptransformation1, maptransformation2)

34304

34305

power = maptransformation ^ exponent

34306

34307

power = lib.map.transformation_power(maptransformation, exponent)

34308

34309

34310

<dt> composition</dt>

34311

<dd>The result of composing two map transformations.

34312

34313

</dd>

34314

<dt> maptransformation1, maptransformation2, maptransformation</dt>

34315

<dd>Map transformations.

34316

34317

</dd>

34318

<dt> power</dt>

34319

<dd>The <code>exponent</code>-th power of <code>maptransformation</code> (again a map

34320

transformation).

34321

34322

</dd>

34323

<dt> exponent</dt>

34324

<dd>An integer.

34325

</dd>

34326

</dl>

34327

34328

</dd>

34329

<dt> Syntax Samples:</dt>

34330

<dd><table><tr><td> </td><td><pre class="example">new_transformation = (MAP_ROT_CW * MAP_FLIP_HORIZONTAL) ^ 2

34331

another_transformation = (new_transformation ^ MAP_ROT_180) ^ (-1)

34332

</pre></td></tr></table>

34333

34334

</dd>

34335

<dt> Details:</dt>

34336

<dd>The eight possible map transformations are the elements of a mathematical

34337

group, the dihedral group of order 8. Composition of any two map

34338

transformations therefore yields another one of the eight map transformations.

34339

An n-th power of a map transformation is the composition of n such

34340

transformations. In the case of the dihedral group, any 4-th power returns the

34341

original element. This fact is applied during calculating a power, so it

34342

doesn’t make a difference to the performance when you use large numbers as

34343

exponents.

34344

34345

Composing with <code>MAP_IDENT</code> doesn’t change the value; it’s like adding zero

34346

to a number, or multiplying with one.

34347

34348

Keeping to group theoretic notions, the operation ‘<samp>^</samp>’ between map

34349

transformations should denote conjugation instead of composition. Instead of

34350

this, it is chosen to be synonymous to ‘<samp>*</samp>’ to allow for associativity of

34351

expressions like:

34352

<table><tr><td> </td><td><pre class="example">new_map = old_map ^ MAP_ROT_CCW ^ MAP_FLIP_VERTICAL

34353

</pre></td></tr></table>

34354

(Remember that Lua evaluates ‘<samp>^</samp>’ from the right.)

34355

34356

The inverse can be calculated with a power to <code>-1</code>, but also by ‘<samp>-</samp>’,

34357

see <a href="#Map-Transformation-Inverse">Map Transformation Inverse</a>.

34358

</dd>

34359

</dl>

34360

34361

34362

34363

34364

34365

34366

34367

34368

34369

34370

34371

34372

34373

34374

34375

34376

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

34377

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

34378

34379

</tr></table>

34380

34381

<h3 class="subsection">12.4.27 Map Transformation Inverse</h3>

34382

34383

The transformation constants (see <a href="#map-read-directions">map read directions</a>,

34384

<a href="#Rotating-and-Mirroring-Maps">Rotating and Mirroring Maps</a>, <a href="#Map-Transformation">Map Transformation</a>) have proper

34385

inverses, i.e. map transformations that reverse their action. These inverse

34386

transformations are returned by ‘<samp>-</samp>’.

34387

34388

34389

<dt> Syntax:</dt>

34390

<dd>inverse = -maptransformation

34391

34392

inverse = lib.map.transformation_inverse(maptransformation)

34393

34394

34395

<dt> inverse</dt>

34396

<dd>The inverse map transformation of <code>maptransformation</code>.

34397

34398

</dd>

34399

<dt> maptransformation</dt>

34400

<dd>A map transformation.

34401

</dd>

34402

</dl>

34403

34404

</dd>

34405

<dt> Syntax Samples:</dt>

34406

<dd><table><tr><td> </td><td><pre class="example">reverse_transformation = -MAP_ROT_CW

34407

</pre></td></tr></table>

34408

In this case, <code>reverse_transformation</code> equals <code>MAP_ROT_CCW</code>, because

34409

their composition <code>MAP_ROT_CW * MAP_ROT_CCW</code> equals the trivial

34410

transformation (or identity) <code>MAP_IDENT</code>.

34411

34412

</dd>

34413

<dt> Details:</dt>

34414

<dd>The eight possible map transformations are the elements of a mathematical

34415

group, the dihedral group of order 8. The inverse of any map transformation

34416

therefore yields another one of the eight map transformations. Composition of

34417

any map transformation with its inverse results in <code>MAP_IDENT</code>. However,

34418

within the dihedral group of order 8, only two elements have inverses that are

34419

not their own inverses: the two rotations by 90 degrees.

34420

34421

Keeping to group theoretic notions, the inverse is denoted by ‘<samp>^ (-1)</samp>’,

34422

which works just as well(see <a href="#Map-Transformation-Composition-and-Powers">Map Transformation Composition and Powers</a>).

34423

</dd>

34424

</dl>

34425

34426

34427

34428

34429

34430

34431

34432

34433

34434

34435

34436

34437

34438

34439

34440

34441

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

34442

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

34443

34444

</tr></table>

34445

34446

<h3 class="subsection">12.4.28 Random Map Transformations</h3>

34447

34448

34449

libmap provides the function <code>lib.map.random_transformation()</code> to pick one

34450

of the eight transformations by random.

34451

34452

34453

<dt> Syntax:</dt>

34454

<dd>randomtransformation = lib.map.random_transformation()

34455

34456

34457

<dt> randomtransformation</dt>

34458

<dd>A map transformation, randomly chosen from <code>MAP_ALL</code>.

34459

</dd>

34460

</dl>

34461

34462

</dd>

34463

<dt> Syntax Samples:</dt>

34464

<dd><table><tr><td> </td><td><pre class="example">wo:drawMap(ti, po(5, 4), mymap, lib.map.random_transformation())

34465

</pre></td></tr></table>

34466

34467

</dd>

34468

<dt> Details:</dt>

34469

<dd>When you use random map transformations, remember that four out of the eight map

34470

transformations switch height and width of the map they are applied to.

34471

</dd>

34472

</dl>

34473

34474

34475

34476

34477

34478

34479

34480

34481

34482

34483

34484

34485

34486

34487

34488

34489

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

34490

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

34491

34492

</tr></table>

34493

34494

<h2 class="section">12.5 libimport</h2>

34495

34496

34497

libimport is dedicated to parse level files of other games or formats and

34498

typically returns <a href="#libmap">libmap</a>-maps. In this context, the word "level" refers to

34499

a string, representing a level of the other game. A "monolevel" is a string

34500

which holds a single level, but also additional information, like titles or

34501

author names. A "multilevel" is a string composed of one or more monolevels.

34502

A "map" is a map in the libmap-sense, i.e. an Enigma level.

34503

34504

Apart from the following functions, lib.import includes the minor routines

34505

‘<samp>lib.import.string_replace</samp>’, which is a wrapper for <code>string.gsub</code>,

34506

and ‘<samp>lib.import.string_remove_multiples</samp>’, which removes multiple

34507

occurrences of a string in another string.

34508

34509

This library is described as of release 1.

34510

34511

You can load it by adding an ‘<samp>dependency</samp>’ element to the

34512

<a href="#g_t_003ccompatibility_003e"><compatibility></a> XML Metadata element as follows:

34513

34514

<table><tr><td> </td><td><pre class="example"> <el:dependency el:path="<var>lib/libimport</var>" el:id="<var>lib/libimport</var>" el:release="<var>1</var>" el:preload="<var>true</var>"/>

34515

</pre></td></tr></table>

34516

34517

It preloads automatically the libraries <a href="#libmap">libmap</a> and <a href="#liblua">liblua</a>.

34518

34519

34520

34521

<tr><td align="left" valign="top"><a href="#lib_002eimport_002eunpack_005fmultilevel">12.5.1 lib.import.unpack_multilevel</a></td><td>  </td><td align="left" valign="top"> Extract a level from a multilevel.

34522

</td></tr>

34523

<tr><td align="left" valign="top"><a href="#lib_002eimport_002euncompress_005frle">12.5.2 lib.import.uncompress_rle</a></td><td>  </td><td align="left" valign="top"> Decode run-length encoding.

34524

</td></tr>

34525

<tr><td align="left" valign="top"><a href="#lib_002eimport_002elevel_005fto_005fmap">12.5.3 lib.import.level_to_map</a></td><td>  </td><td align="left" valign="top"> Converts a level into a map.

34526

</td></tr>

34527

<tr><td align="left" valign="top"><a href="#lib_002eimport_002emap_005fsokoban">12.5.4 lib.import.map_sokoban</a></td><td>  </td><td align="left" valign="top"> Converts a Sokoban level into a map.

34528

</td></tr>

34529

<tr><td align="left" valign="top"><a href="#lib_002eimport_002emap_005fwanderer">12.5.5 lib.import.map_wanderer</a></td><td>  </td><td align="left" valign="top"> Converts a Wanderer level into a map.

34530

</td></tr>

34531

</table>

34532

34533

34534

34535

34536

34537

34538

34539

34540

34541

34542

34543

34544

34545

34546

34547

34548

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

34549

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

34550

34551

</tr></table>

34552

34553

<h3 class="subsection">12.5.1 lib.import.unpack_multilevel</h3>

34554

34555

34556

‘<samp>unpack_multilevel</samp>’ extracts a level from a multilevel string. For this,

34557

it needs a regexp describing a single level line.

34558

34559

34560

<dt> Syntax:</dt>

34561

<dd>lib.import.unpack_multilevel(multilevel, sublevel_number, format)

34562

34563

34564

<dt> multilevel</dt>

34565

<dd>A multilevel string.

34566

34567

</dd>

34568

<dt> sublevel_number</dt>

34569

<dd>The number of the level in <code>multilevel</code> to be extracted. First level is

34570

‘<samp>1</samp>’. If <code>nil</code>, ‘<samp>1</samp>’ is taken as default.

34571

34572

</dd>

34573

<dt> format</dt>

34574

<dd>A string referencing an entry in ‘<samp>lib.import.line_regexp</samp>’. Currently, only

34575

‘<samp>sokoban</samp>’ and ‘<samp>wanderer</samp>’ are supported. But you can add further

34576

entries to ‘<samp>lib.import.line_regexp</samp>’ if necessary.

34577

</dd>

34578

</dl>

34579

34580

</dd>

34581

<dt> Syntax Samples:</dt>

34582

<dd><table><tr><td> </td><td><pre class="example">level_four = lib.import.unpack_multilevel(large_string, 4, "sokoban")

34583

</pre></td></tr></table>

34584

34585

</dd>

34586

<dt> Details:</dt>

34587

<dd>A level extracted with <code>unpack_multilevel</code> has still to be converted into

34588

a format Enigma understands. A level is a string, and lines of the level are to

34589

be determined by line endings, which can be quite different. In contrast to

34590

this, an Enigma map is a table of strings, with each line in a separate entry

34591

of the table. Hence, at least the line endings have to be dealt with.

34592

</dd>

34593

</dl>

34594

34595

34596

34597

34598

34599

34600

34601

34602

34603

34604

34605

34606

34607

34608

34609

34610

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

34611

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

34612

34613

</tr></table>

34614

34615

<h3 class="subsection">12.5.2 lib.import.uncompress_rle</h3>

34616

34617

34618

‘<samp>uncompress_rle</samp>’ takes a string as argument and returns a decoded version

34619

without run-length encoding.

34620

34621

34622

<dt> Syntax:</dt>

34623

<dd>lib.import.uncompress_rle(level, attribs)

34624

34625

34626

<dt> level</dt>

34627

<dd>A level string.

34628

34629

</dd>

34630

<dt> attribs</dt>

34631

<dd>A table containing further parameters. Currently, the only supported parameter

34632

is ‘<samp>error_on_multiple</samp>’.

34633

</dd>

34634

</dl>

34635

34636

</dd>

34637

<dt> Syntax Samples:</dt>

34638

<dd><table><tr><td> </td><td><pre class="example">uncompressed = lib.import.uncompress_rle(compressed, {error_on_multiple = "\n"})

34639

</pre></td></tr></table>

34640

34641

</dd>

34642

<dt> Details:</dt>

34643

<dd>Levels typically include long lines of repeating characters, like walls or

34644

spaces. To save space, these are sometimes counted and replaced by the total

34645

number and a single example of the character. This is called "run-length

34646

encoding", or RLE.

34647

<table><tr><td> </td><td><pre class="example">"############ A #####BB#" compresses to "12#2 A5#2B#"

34648

</pre></td></tr></table>

34649

However, some characters don’t make sense to be repeated, like line endings.

34650

To return an error when trying to repeat a line ending during decompression,

34651

you can hand a string to the attribute ‘<samp>error_on_multiple</samp>’. Any character

34652

in this string is then forbidden to be repeated. Remember that the ‘<samp>new

34653

line</samp>’-character is represented by ‘<samp>\n</samp>’ in Lua.

34654

</dd>

34655

</dl>

34656

34657

34658

34659

34660

34661

34662

34663

34664

34665

34666

34667

34668

34669

34670

34671

34672

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

34673

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

34674

34675

</tr></table>

34676

34677

<h3 class="subsection">12.5.3 lib.import.level_to_map</h3>

34678

34679

34680

‘<samp>level_to_map</samp>’ breaks a level string down into a table of strings, which

34681

is then converted into a <a href="#libmap">libmap</a>-map.

34682

34683

34684

<dt> Syntax:</dt>

34685

<dd>lib.import.level_to_map(level, line_ending, default_key)

34686

34687

34688

<dt> level</dt>

34689

<dd>A level string.

34690

34691

</dd>

34692

<dt> line_ending</dt>

34693

<dd>A string describing a single line ending. Default: ‘<samp>\n</samp>’

34694

34695

</dd>

34696

<dt> default_key</dt>

34697

<dd>The default key of the returned map. Default: ‘<samp> </samp>’

34698

</dd>

34699

</dl>

34700

34701

</dd>

34702

<dt> Syntax Samples:</dt>

34703

<dd><table><tr><td> </td><td><pre class="example">mymap = lib.import.level_to_map(level, "|", " ")

34704

</pre></td></tr></table>

34705

34706

</dd>

34707

<dt> Details:</dt>

34708

<dd>Multiple line endings are interpreted as multiple lines (of which the last

34709

lines are filled with the default key).

34710

34711

Make sure that the last line of the level ends in a proper line ending, and only

34712

one line ending. Otherwise, the returned map will be too short or too long.

34713

</dd>

34714

</dl>

34715

34716

34717

34718

34719

34720

34721

34722

34723

34724

34725

34726

34727

34728

34729

34730

34731

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

34732

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

34733

34734

</tr></table>

34735

34736

<h3 class="subsection">12.5.4 lib.import.map_sokoban</h3>

34737

34738

34739

‘<samp>map_sokoban</samp>’ takes a Sokoban multilevel as argument, and returns a

34740

beautified <a href="#libmap">libmap</a>-map.

34741

34742

34743

<dt> Syntax:</dt>

34744

<dd>lib.import.map_sokoban(multilevel, sublevel_number, keylength_one)

34745

34746

34747

<dt> multilevel</dt>

34748

<dd>A multilevel string.

34749

34750

</dd>

34751

<dt> sublevel_number</dt>

34752

<dd>The number of the level to be extracted. First level is ‘<samp>1</samp>’. Default:

34753

‘<samp>1</samp>’

34754

34755

</dd>

34756

<dt> keylength_one</dt>

34757

<dd>A boolean value. If <code>false</code>, the returned map has keylength two. Otherwise,

34758

it has keylength one. Default: ‘<samp>false</samp>’

34759

</dd>

34760

</dl>

34761

34762

</dd>

34763

<dt> Syntax Samples:</dt>

34764

<dd><table><tr><td> </td><td><pre class="example">map_four = lib.import.map_sokoban(multilevel, 4, true)

34765

</pre></td></tr></table>

34766

34767

</dd>

34768

<dt> Details:</dt>

34769

<dd>Sokoban level files can be very different - they can use run-length encoding and

34770

multilevel files. Sometimes, ‘<samp>|</samp>’ is used as line ending instead of or even

34771

together with ‘<samp>\n</samp>’. ‘<samp> </samp>’, ‘<samp>_</samp>’ and ‘<samp>-</samp>’ can all represent

34772

space. Sometimes, the outside is filled with ‘<samp> </samp>’, then again with ‘<samp>#</samp>’.

34773

Finally, line width can vary. We use a slightly generalized version, to include

34774

chessoban levels. Allowed characters are:

34775

<table><tr><td> </td><td><pre class="example"> - _ space space

34776

# wall

34777

. goal

34778

$ * box, box with goal

34779

n N st_chess, st_chess with goal

34780

@ + player, player with goal

34781

</pre></td></tr></table>

34782

The returned map will use ‘<samp> </samp>’ for inside space, ‘<samp>-</samp>’ for

34783

outside space, default key is ‘<samp> </samp>’.

34784

34785

If you chose ‘<samp>keylength_one = true</samp>’, the returned map will use the

34786

characters as described above. Otherwise, the returned map will have keylength

34787

two, and the characters ‘<samp>*</samp>’, ‘<samp>N</samp>’, and ‘<samp>+</samp>’ are resolved into

34788

‘<samp>$.</samp>’, ‘<samp>n.</samp>’, and ‘<samp>@.</samp>’ respectively, while the other keys become

34789

‘<samp> </samp>’, ‘<samp>- </samp>’, ‘<samp># </samp>’, ‘<samp> .</samp>’, ‘<samp>$ </samp>’, ‘<samp>n </samp>’, and

34790

‘<samp>@ </samp>’. You can then use <a href="#res_002ecomposer">res.composer</a> to easily draw your map.

34791

34792

Remember that the returned map uses the inner space ‘<samp> </samp>’ or ‘<samp> </samp>’ as

34793

default key. Hence, if you want to paste the map into another one

34794

(<a href="#Connecting-Two-Maps">Connecting Two Maps</a>), you will have to switch the default key to

34795

‘<samp>-</samp>’ or ‘<samp>- </samp>’ in beforehand to yield a good result.

34796

</dd>

34797

</dl>

34798

34799

34800

34801

34802

34803

34804

34805

34806

34807

34808

34809

34810

34811

34812

34813

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

34814

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

34815

34816

</tr></table>

34817

34818

<h3 class="subsection">12.5.5 lib.import.map_wanderer</h3>

34819

34820

34821

‘<samp>map_wanderer</samp>’ takes a Wanderer monolevel as argument, and returns a

34822

<a href="#libmap">libmap</a>-map. Note that Enigma does not yet have the necessary game objects

34823

to simulate Wanderer.

34824

34825

34826

<dt> Syntax:</dt>

34827

<dd>lib.import.map_wanderer(monolevel)

34828

34829

34830

<dt> monolevel</dt>

34831

<dd>A monolevel string.

34832

</dd>

34833

</dl>

34834

34835

</dd>

34836

<dt> Syntax Samples:</dt>

34837

<dd><table><tr><td> </td><td><pre class="example">mymap = lib.import.map_wanderer(monolevel)

34838

</pre></td></tr></table>

34839

34840

</dd>

34841

<dt> Details:</dt>

34842

<dd>Wanderer is a game originally created by Steven Shipway in 1988.

34843

Wanderer level files are uncompressed monolevels with fixed

34844

width. The level itself is followed by a short description

34845

(title/author/email) in a single line or a line of ‘<samp>#</samp>’. Last

34846

line optionally is a number. A Wanderer level knows the

34847

following characters (taken from Wanderer’s editor):

34848

<table><tr><td> </td><td><pre class="example"> : _ # earth, rock, indestructible rock

34849

* - space treasure, alternative space, space

34850

O < > ^ falling boulder, arrow from right, arrow from left, balloon

34851

! + B landmine, cage, bomb

34852

/ \ deflectors

34853

T A X @ teleport, arrival, exit, start

34854

M S C ~ big monster, baby monster, time capsule, thingy

34855

</pre></td></tr></table>

34856

Due to its fixed width (40) and height (16), a Wanderer level is not always

34857

surrounded by walls; you might have to add them.

34858

34859

Note that Enigma does not yet support the game elements of Wanderer, hence this

34860

function currently is only of use to developers.

34861

</dd>

34862

</dl>

34863

34864

34865

34866

34867

34868

34869

34870

34871

34872

34873

34874

34875

34876

34877

34878

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

34879

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

34880

34881

</tr></table>

34882

34883

<h2 class="section">12.6 libsoko</h2>

34884

34885

34886

This library is described as of release 1.

34887

34888

You can load it by adding an ‘<samp>dependency</samp>’ element to the

34889

<a href="#g_t_003ccompatibility_003e"><compatibility></a> XML Metadata element as follows:

34890

34891

<table><tr><td> </td><td><pre class="example"> <el:dependency el:path="<var>lib/libsoko</var>" el:id="<var>lib/libsoko</var>" el:release="<var>1</var>" el:preload="<var>true</var>"/>

34892

</pre></td></tr></table>

34893

34894

It preloads automatically the libraries <a href="#libimport">libimport</a>, <a href="#libmap">libmap</a>,

34895

<a href="#libmath">libmath</a>, and <a href="#liblua">liblua</a>.

34896

34897

The only function which is meant to be used in levels is

34898

‘<samp>lib.soko.create_sokoball</samp>’.

34899

34900

34901

<dt> Syntax:</dt>

34902

<dd>lib.soko.create_sokoball(multilevel, sublevel_number, args)

34903

34904

34905

<dt> multilevel</dt>

34906

<dd>A multilevel string in the sense of <a href="#libimport">libimport</a>.

34907

34908

</dd>

34909

<dt> sublevel_number</dt>

34910

<dd>A number determining the number of the level in <code>multilevel</code>. Default is

34911

‘<samp>1</samp>’.

34912

34913

</dd>

34914

34915

<dd>A table holding optional information to construct the level,

34916

default is {}. The following keywords are currently supported,

34917

all other keywords will return an error:

34918

34919

<dt> design</dt>

34920

<dd>A number or a design table, see below.

34921

34922

</dd>

34923

<dt> maxdesign</dt>

34924

<dd>A number, see below.

34925

</dd>

34926

</dl>

34927

</dd>

34928

</dl>

34929

34930

</dd>

34931

<dt> Syntax Samples:</dt>

34932

<dd><table><tr><td> </td><td><pre class="example">lib.soko.create_sokoball(many_levels, 13, {design = 48})

34933

lib.soko.create_sokoball(many_levels, 12, {maxdesign = MAXDESIGN[1.1]})

34934

</pre></td></tr></table>

34935

34936

</dd>

34937

<dt> Details:</dt>

34938

<dd>‘<samp>create_sokoball</samp>’ creates a sokoball-level from the string

34939

<code>multilevel</code>. This string can be a multilevel, in which case

34940

‘<samp>sublevel_number</samp>’ determines the number of the level, starting with 1

34941

(default is 1).

34942

34943

The design can be chosen by ‘<samp>design</samp>’. This is either a number, which refers

34944

to the list of predefined designs in <code>libsoko_designlist.xml</code>, or a table

34945

with the corresponding design entries. A missing entry will be interpreted as

34946

the entry from lib.soko_designlist.default. If the ‘<samp>design</samp>’ variable is

34947

omitted, a check-number is created from the level which uniquely* determines

34948

a design from the design list, with <code>maxdesign</code> as highest possible

34949

design number.

34950

34951

*Uniquely means: The design might change when the design list is enlarged.

34952

34953

The number of available designs is 150 in Enigma 1.1, which equals the constant

34954

<code>MAXDESIGN[1.1]</code>. However, further versions of Enigma might support more

34955

designs. If a multilevel is loaded with a (numerically given) maxdesign number

34956

which is larger than the number of available designs, only those levels will be

34957

available for play whose calculated design number is supported, all others will

34958

show an error message. However, it is better to use the MAXDESIGN-constants.

34959

These will always raise an error, when the requested designs are not available.

34960

The MAXDESIGN-constants are read-only.

34961

34962

If both the design argument as well as the maxdesign-number are

34963

omitted, the original 150 designs will be used as fallback, no matter which

34964

version of Enigma is running.

34965

34966

To define own designs, please consult

34967

‘<samp>data/levels/lib/libsoko_designlist.xml</samp>’

34968

or use <a href="#libimport">libimport</a> in the first place.

34969

34970

Returns width and height of new Enigma level.

34971

</dd>

34972

</dl>

34973

34974

34975

34976

34977

34978

34979

34980

34981

34982

34983

34984

34985

34986

34987

34988

34989

34990

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

34991

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

34992

34993

</tr></table>

34994

34995

<h1 class="chapter">13. Advanced Features</h1>

34996

34997

34998

<tr><td align="left" valign="top"><a href="#Resolvers">13.1 Resolvers</a></td><td>  </td><td align="left" valign="top"> Standard tools for interpretation of tile maps

34999

</td></tr>

35000

<tr><td align="left" valign="top"><a href="#General-Features">13.2 General Features</a></td><td>  </td><td align="left" valign="top"> Special features like scrolling, flood, fire,...

35001

</td></tr>

35002

<tr><td align="left" valign="top"><a href="#Tips-and-Tricks">13.3 Tips and Tricks</a></td><td>  </td><td align="left" valign="top"> Simple patterns that are valuable like a feature

35003

</td></tr>

35004

</table>

35005

35006

35007

35008

35009

35010

35011

35012

35013

35014

35015

35016

35017

35018

35019

35020

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

35021

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

35022

35023

</tr></table>

35024

35025

<h2 class="section">13.1 Resolvers</h2>

35026

35027

Every tile in the world is defined by a key that needs to be resolved to its

35028

declaration. This can be done either by the <a href="#Tiles-Repository">Tiles Repository</a> ‘<samp>ti</samp>’

35029

alone, or by additionally chained resolvers. In the chapter <a href="#Lua-API">Lua API</a> we

35030

learned how to set up a <a href="#World">World</a> by static <a href="#Tile-and-Object-Declaration">Tile and Object Declaration</a>s.

35031

Now it is time to explore the capabilities of resolvers. In the

35032

<a href="#World-Creation">World Creation</a> you had to supply a top resolver as an argument. Let us

35033

look which types of resolvers are available and how you can chain these resolvers.

35034

35035

35036

<tr><td align="left" valign="top"><a href="#Resolver-Chaining">13.1.1 Resolver Chaining</a></td><td>  </td><td align="left" valign="top"> Linking resolvers and the tiles repository

35037

</td></tr>

35038

<tr><td align="left" valign="top"><a href="#Custom-Resolver">13.1.2 Custom Resolver</a></td><td>  </td><td align="left" valign="top"> Writing simplified own resolvers

35039

</td></tr>

35040

<tr><td align="left" valign="top"><a href="#res_002eautotile">13.1.3 res.autotile</a></td><td>  </td><td align="left" valign="top"> Generate tiles from given template declarations

35041

</td></tr>

35042

<tr><td align="left" valign="top"><a href="#res_002ecomposer">13.1.4 res.composer</a></td><td>  </td><td align="left" valign="top"> Compose tiles from given base tiles

35043

</td></tr>

35044

<tr><td align="left" valign="top"><a href="#res_002emaze">13.1.5 res.maze</a></td><td>  </td><td align="left" valign="top"> Generate arbitrarily shaped mazes

35045

</td></tr>

35046

<tr><td align="left" valign="top"><a href="#res_002epuzzle">13.1.6 res.puzzle</a></td><td>  </td><td align="left" valign="top"> Generate puzzle tiles and shuffle resulting puzzle clusters

35047

</td></tr>

35048

<tr><td align="left" valign="top"><a href="#res_002erandom">13.1.7 res.random</a></td><td>  </td><td align="left" valign="top"> Choosing random tiles in a given distribution

35049

</td></tr>

35050

<tr><td align="left" valign="top"><a href="#res_002etrain">13.1.8 res.train</a></td><td>  </td><td align="left" valign="top"> Set up floor chains that move on given railways

35051

</td></tr>

35052

</table>

35053

35054

35055

35056

35057

35058

35059

35060

35061

35062

35063

35064

35065

35066

35067

35068

35069

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

35070

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

35071

35072

</tr></table>

35073

35074

<h3 class="subsection">13.1.1 Resolver Chaining</h3>

35075

35076

There exist several useful resolvers that may simplify the task of level writing

35077

or provide dynamic features like randomness, mazes, etc. Each of them handles

35078

just some keys out of your world map. For the other keys the resolver has no

35079

idea how to resolve them to object declarations. Thus each resolver has to be

35080

linked to a so called ‘<samp>subresolver</samp>’. The resolver just forwards all key

35081

request that it can not handle itself to its subresolver. Indeed it will in

35082

most cases even forward modified key requests to its subresolver that are

35083

required by the process of handling its own keys.

35084

35085

The last resolver in the chain will either use the <a href="#Tiles-Repository">Tiles Repository</a>

35086

‘<samp>ti</samp>’ as its subresolver or a <a href="#Custom-Resolver">Custom Resolver</a> function, which will be

35087

‘<samp>ti</samp>’ based, too.

35088

35089

A typical resolver chain will look like:

35090

35091

35092

35093

<dt> Syntax Sample:</dt>

35094

<dd><table><tr><td> </td><td><pre class="example"><var>subresolver</var> = res.random(ti, ...)

35095

<var>topresolver</var> = res.composer(<var>subresolver</var>)

35096

width, height = wo(<var>topresolver</var>, ...)

35097

</pre></td></tr></table>

35098

35099

</dd>

35100

<dt> Details:</dt>

35101

<dd>The call of every resolver returns a context reference handle, that must be

35102

supplied to the upward resolver in the chain. Thus you need to start with the

35103

lowest resolver in your level code. The <a href="#World-Creation">World Creation</a> takes the top most

35104

resolver context handle.

35105

35106

There is no limit to the number of chained resolvers. But the order of resolvers

35107

may sometimes be critical. Please read carefully the resolver notes for usage,

35108

restrictions and caveats.

35109

35110

</dd>

35111

<dt> Full Example:</dt>

35112

<dd>The level "Demo Resolver Chain" of levelpack "Demolevels":

35113

<table><tr><td> </td><td><pre class="example">ti["~"] = {"fl_water"}

35114

ti["s"] = {"fl_sahara"}

35115

ti["t"] = {"fl_tigris"}

35116

ti["1"] = {"ac-blackball", 0, 0.5}

35117

35118

ti["template_trigger"] = {"it_trigger", target="myoxyd%%", action="open"}

35119

ti["template_oxyd"] = ti["~"] .. {"st_oxyd", "myoxyd%%"}

35120

35121

myrandom = res.random(ti, " ", {"s", "t"})

35122

35123

myautotile = res.autotile(myrandom, {"a", "h", "template_trigger"},

35124

{"A", "H", "template_oxyd"})

35125

35126

w, h = wo(myautotile, " ", {

35127

"A~ ~E",

35128

"~~ ~~",

35129

"~~ h b ~~",

35130

"~~ ~~",

35131

"B~ c d ~F",

35132

"~~ ~~",

35133

"~~ 1 ~~",

35134

"~~ ~~",

35135

"C~ f e ~G",

35136

"~~ ~~",

35137

"~~ g a ~~",

35138

"~~ ~~",

35139

"D~ ~H"

35140

})

35141

35142

wo:shuffleOxyd()

35143

</pre></td></tr></table>

35144

</dd>

35145

</dl>

35146

35147

35148

35149

35150

35151

35152

35153

35154

35155

35156

35157

35158

35159

35160

35161

35162

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

35163

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

35164

35165

</tr></table>

35166

35167

<h3 class="subsection">13.1.2 Custom Resolver</h3>

35168

35169

35170

A customer resolver is a function in the level that allows a dynamic remapping

35171

of tiles. When this function is registered in the resolver chain it is called

35172

once for every tile to be set. The tile that this function return will be set.

35173

35174

Typical use cases are design patterns that are easy to calculate, but tedious

35175

to draw in the map and dynamic generated levels that differ slightly on every

35176

restart.

35177

35178

35179

<dt> Syntax:</dt>

35180

<dd>tile = myresolver(key, x, y)

35181

35182

35183

35184

<dd>String that contains the tile key to be resolved.

35185

</dd>

35186

35187

<dd>The world x coordinate of the tile.

35188

</dd>

35189

35190

<dd>The world y coordinate of the tile.

35191

</dd>

35192

</dl>

35193

35194

</dd>

35195

<dt> Details:</dt>

35196

<dd>A custom resolver function is the last resolver that is called in the chain.

35197

It has to return the final tile that should be drawn at the given position.

35198

This can be done by statement ‘<samp>return ti["k"]</samp>’, which references the tile

35199

already declared in the tiles map.

35200

35201

If no suitable tile was declared you can alternatively return a new tile

35202

like ‘<samp>return ti({"st_switch", state=ON})</samp>’.

35203

35204

If you decide not to draw any tile at all, you must return an empty tile

35205

declaration: ‘<samp>return {"nil"}</samp>’ or ‘<samp>return {}</samp>’.

35206

35207

‘<samp>return nil</samp>’ indicates an error of usage of an unknown tile key.

35208

35209

</dd>

35210

<dt> Example:</dt>

35211

<dd>The level "Demo User Resolver" of levelpack "Demolevels":

35212

<table><tr><td> </td><td><pre class="example">ti["r"] = {"fl_rough_red"}

35213

ti["b"] = {"fl_rough_blue"}

35214

ti["1"] = {"#ac-blackball"}

35215

35216

ti["x"] = {"it_cross"}

35217

35218

function myresolver(key, x, y)

35219

if key == " " then

35220

local center = ((x%3) * (y%3))%2

35221

local checker = ((math.modf(x/3) %2) + (math.modf(y/3) %2))%2

35222

if center + checker == 1 then

35223

return ti["r"]

35224

else

35225

return ti["b"]

35226

end

35227

else

35228

return ti[key]

35229

end

35230

end

35231

35232

w, h = wo(myresolver, " ", {

35233

" ",

35234

" ",

35235

" ",

35236

" x x ",

35237

" x ",

35238

" x x ",

35239

" ",

35240

" 1 ",

35241

" ",

35242

" ",

35243

" ",

35244

" ",

35245

" "

35246

})

35247

</pre></td></tr></table>

35248

</dd>

35249

</dl>

35250

35251

35252

35253

35254

35255

35256

35257

35258

35259

35260

35261

35262

35263

35264

35265

35266

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

35267

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

35268

35269

</tr></table>

35270

35271

<h3 class="subsection">13.1.3 res.autotile</h3>

35272

35273

35274

Autotiling reduces the number of required tile declarations by generating them

35275

according to given simple rules. The most common application are a bunch of

35276

identical switch like objects that all target the same type of object

35277

like a door or a laser. As each of them has its individual target object it

35278

would require to write a separate tile declaration with a unique tile key, e.g.

35279

35280

<table><tr><td> </td><td><pre class="example">ti["A"] = {"st_floppy", target="laserA"}

35281

ti["B"] = {"st_floppy", target="laserB"}

35282

ti["C"] = {"st_floppy", target="laserC"}

35283

ti["a"] = {"st_laser", name="laserA"}

35284

ti["b"] = {"st_laser", name="laserB"}

35285

ti["c"] = {"st_laser", name="laserC"}

35286

</pre></td></tr></table>

35287

35288

Autotiling requires just one template tile of each type and substitutes any

35289

pattern ‘<samp>%%</samp>’ by a unique substitution.

35290

35291

<table><tr><td> </td><td><pre class="example">ti["template_switch"] = {"st_floppy", target="laser%%"}

35292

ti["template_laser"] = {"st_laser", name="laser%%"}

35293

</pre></td></tr></table>

35294

35295

Independent on the number of required unique objects you have just one template.

35296

You just declare the used range of tile keys by a rule and are free to use

35297

them within your level map.

35298

35299

35300

<dt> Syntax:</dt>

35301

<dd>

35302

res.autotile(subresolver, rules)

35303

35304

35305

<dt> subresolver</dt>

35306

<dd>Resolver to which unresolved requests should be forwarded. May be ‘<samp>ti</samp>’

35307

as the final resolver of the resolver chain.

35308

</dd>

35309

<dt> rules = rule, rule,...</dt>

35310

<dd>One rule or as many as you like, all separated by a comma.

35311

</dd>

35312

<dt> rule = prefixrule | rangerule</dt>

35313

<dd>Each rule can be either a prefixrule or a rangerule in any mixture

35314

</dd>

35315

<dt> prefixrule = {prefix, template}</dt>

35316

<dd>A table with two entries. First a prefix string that is common to all tile

35317

keys that should be handled followed by key string of the template tile.

35318

</dd>

35319

<dt> rangerule = {first, last, template [, offset]}</dt>

35320

<dd>A table with at least three entries. A string with the first key to be handled,

35321

followed by a string with the last key to be handled. The third value is the key

35322

string of the template tile. An optional fourth value, that defaults to <code>1</code>,

35323

defines the number of the first key on ‘<samp>%%</samp>’ pattern substitutions.

35324

</dd>

35325

</dl>

35326

35327

</dd>

35328

<dt> Syntax Samples:</dt>

35329

<dd><table><tr><td> </td><td><pre class="example">res.autotile(ti, {"A", "template_switch"}, {"L", "template_laser})

35330

res.autotile(ti, {"a", "e", "template_trigger}, {"A", "E", "template_door"}

35331

</pre></td></tr></table>

35332

35333

</dd>

35334

<dt> Details:</dt>

35335

<dd>Prefix rules need a key length of at least 2. You can not use it with maps

35336

of just one character per tile. The resolver will create a tile declaration for

35337

any tile key in the map that matches the given prefix. A copy of the template

35338

will be taken.

35339

35340

Within this copy of the template all occurrences of the two characters ‘<samp>%%</samp>’

35341

in explicit object declarations will be substituted by a single percent sign

35342

followed by the suffix of the used tile key. Thus a key of ‘<samp>AD</samp>’ will target

35343

the laser ‘<samp>laser%D</samp>’. You need to use the key ‘<samp>LD</samp>’ in the map for the

35344

matching laser.

35345

35346

Rangerules match any tile key in the given range. It can well be used in one

35347

character key maps. But it can be used in multicharacter maps, too. In this case

35348

the given first and last keys may just differ in the last character. Again a

35349

copy of the template rule will be generated and the ‘<samp>%%</samp>’ patterns will be

35350

substituted. But in this case the substitution is composed of a single percent

35351

sign followed by an integer number, that counts the key position within the

35352

given range, starting with the given offset or default <code>1</code>. Thus a key of

35353

‘<samp>c</samp>’ in the syntax sample above will target the door ‘<samp>door%3</samp>’. You

35354

would need to use the key ‘<samp>C</samp>’ in the map for the matching door.

35355

35356

The template tile definitions can well be composed of several concatenated

35357

tiles even with references of base tiles. The pattern substitution takes place

35358

on any attribute value containing string descriptions. A valid template would

35359

be:

35360

<table><tr><td> </td><td><pre class="example">ti["template"] = ti["~"] .. ti({"it_trigger", target={"door%%#*","laser%%"}}) .. {"st_grate1"}

35361

</pre></td></tr></table>

35362

35363

A pattern substitution can even take place on a key of a referenced base tile.

35364

Every occurrence of the two characters ‘<samp>%%</samp>’ in the key will be substituted

35365

by the suffix of the used tile key without a preceeding percent sign. E.g. the

35366

template:

35367

35368

<table><tr><td> </td><td><pre class="example">ti["template"] = ti["P%%"] .. {"st_floppy", target="laser%%"}

35369

</pre></td></tr></table>

35370

35371

applied to a key with the suffix ‘<samp>d</samp>’ will result in a base tile key ‘<samp>Pd</samp>’.

35372

This feature is especially useful if the autotile resolver is chained to

35373

another subresolver which generates the base tiles.

35374

35375

</dd>

35376

<dt> Full Example:</dt>

35377

<dd><table><tr><td> </td><td><pre class="example">ti[" "] = {"fl_sahara"}

35378

35379

ti["template_a"] = {"st_floppy", target={"door%%#*","laser%%"}}

35380

ti["template_A"] = {"st_blocker", "door%%#"}

35381

ti["template_1"] = {"st_laser_s", "laser%%"}

35382

35383

ti["x"] = {"#ac-marble_black"} .. ti({"it_floppy"})

35384

35385

local resolver = res.autotile(ti, {"a", "e", "template_a"},

35386

{"A", "E", "template_A"}, {"1", "5", "template_1"})

35387

35388

w, h = wo(resolver, " ", {

35389

" ",

35390

" ",

35391

" a DB e BC ",

35392

" ",

35393

" CD b AE c ",

35394

" ",

35395

" d EA ",

35396

" ",

35397

" x ",

35398

" ",

35399

" ",

35400

" 4 2 5 1 3 ",

35401

" "

35402

})

35403

</pre></td></tr></table>

35404

A more elaborate example can be found in <a href="#Orthogonal-Autotiling">Orthogonal Autotiling</a>.

35405

35406

</dd>

35407

<dt> Caveats:<a name="Caveats"></a></dt>

35408

<dd>Do not use the hash sign ‘<samp>#</samp>’ as suffix character for key length 2 and

35409

above autotiled keys. A key <code>"A#"</code> could result in an unexpected ‘<samp>%%</samp>’

35410

substitution in the name attribute. A name <code>"sample%%"</code> would be

35411

substituted by <code>"sample%#"</code> which is a name that will be autonumbered

35412

(see section <a href="#Object-Naming">Object Naming</a>).

35413

</dd>

35414

</dl>

35415

35416

35417

35418

35419

35420

35421

35422

35423

35424

35425

35426

35427

35428

35429

35430

35431

35432

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

35433

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

35434

35435

</tr></table>

35436

35437

<h3 class="subsection">13.1.4 res.composer</h3>

35438

35439

35440

The composer resolver reduces the number of required tile declarations by

35441

generating them by composition of base tiles. Even small levels and nearly

35442

every large level will use many different objects in numerous tile compositions.

35443

As the usable one character tile key candidates will not suffice you will need

35444

to use two or three character tile keys. But you will need numerous tile

35445

declarations, one for every used object combination.

35446

35447

The composer frees you from declaring every used combination. You just declare

35448

the base objects, e.g. the floors and all stones, items, actors and use

35449

combinations of these base tiles keys. The composer constructs the required

35450

tile declarations on the fly. E.g. with the following base tile declarations:

35451

35452

<table><tr><td> </td><td><pre class="example">ti[" ."] = {"fl_space"}

35453

ti[" ~"] = {"fl_water"}

35454

ti["X "] = {"st_grate"}

35455

ti["h "] = {"it_hammer"}

35456

</pre></td></tr></table>

35457

35458

You can freely use any of the additional combination like <code>"X."</code> - a grate

35459

on space, <code>"X~"</code> - a grate on water, <code>"h."</code> - a hammer on space,

35460

<code>"h~"</code> - a hammer on water.

35461

35462

35463

<dt> Syntax:</dt>

35464

<dd>

35465

res.composer(subresolver)

35466

35467

res.composer(subresolver, sequence)

35468

35469

35470

<dt> subresolver</dt>

35471

<dd>Resolver to which unresolved requests should be forwarded. May be ‘<samp>ti</samp>’

35472

as the final resolver of the resolver chain.

35473

</dd>

35474

<dt> sequence</dt>

35475

<dd>Search sequence for basic tile declarations given as a string of priority

35476

numbers. The sequence defaults to <code>"123456789"</code>.

35477

</dd>

35478

</dl>

35479

35480

</dd>

35481

<dt> Syntax Samples:</dt>

35482

<dd><table><tr><td> </td><td><pre class="example">res.composer(ti)

35483

</pre></td></tr></table>

35484

35485

</dd>

35486

<dt> Details:</dt>

35487

<dd>For every key in the map the subresolver will be first requested for a tile

35488

declaration. Thus any given explicit declaration will precede the auto

35489

composition.

35490

35491

Just in case that no declaration exists the search starts for existing subkey

35492

tiles. Subkeys are keys with all but some characters replaced by a whitespace

35493

‘<samp> </samp>’.

35494

35495

The search sequence is given by the optional second argument and defaults to

35496

<code>"123456789"</code>. In the first step all character positions marked by a

35497

‘<samp>1</samp>’ in the sequence string are maintained in the key string and all others

35498

are replaced by whitespace. In the second step all character positions marked

35499

by a ‘<samp>2</samp>’ in the sequence string are maintained in the key string and all

35500

others are replaced by whitespace. This procedure continues until the number

35501

equals the key length. All generated subkeys are resolved by the subresolver

35502

and concatenated in the given sequence.

35503

35504

With the default sequence <code>"123456789"</code> a key request for <code>"~mX"</code> is

35505

resolved to subkeys <code>"~ "</code>, <code>" m "</code> and <code>" X"</code>. These subkeys

35506

are resolved by the subresolver. If the subresolver is ‘<samp>ti</samp>’ the result is:

35507

35508

<table><tr><td> </td><td><pre class="example">ti["~ "] .. ti[" m "] .. ti[" X"]

35509

</pre></td></tr></table>

35510

35511

With a key length of 3 or more characters it is sometimes useful to avoid a

35512

total decomposition into single character based subkeys. E.g. you may want

35513

to use a <a href="#res_002eautotile">res.autotile</a> or <a href="#res_002epuzzle">res.puzzle</a> as subresolver. Both have the

35514

need of essential 2 character subkeys. In this case you can simply define

35515

the sequence as <code>"122"</code> for a key length of 3. A key request of

35516

<code>"~Pa"</code> will be resolved to subkeys <code>"~ "</code>, <code>" Pa"</code>. In case

35517

of a puzzle subresolver this would result in:

35518

35519

<table><tr><td> </td><td><pre class="example">ti["~ "] .. ti[" P"]

35520

</pre></td></tr></table>

35521

35522

with second tile declaration being a <a href="#st_005fpuzzle">st_puzzle</a> declaration with the

35523

‘<samp>connections</samp>’ attribute being set to <code>"w"</code> according to the last key

35524

character ‘<samp>a</samp>’.

35525

35526

With a <code>"231"</code> you stick to a total decomposition, but you redefine the

35527

sequence of evaluation and composition. For the key <code>"~mX"</code> you would get

35528

in contrast to the first example:

35529

35530

<table><tr><td> </td><td><pre class="example">ti[" X"] .. ti["~ "] .. ti[" m "]

35531

</pre></td></tr></table>

35532

35533

In all cases, subkeys, that are strings of whitespace only, will simply be

35534

ignored. With the default sequence the key <code>"~ X"</code> will result just in:

35535

35536

<table><tr><td> </td><td><pre class="example">ti["~ "] .. ti[" X"]

35537

</pre></td></tr></table>

35538

35539

If you set your floors by usage of the composer you should use the all

35540

whitespace key as your default floor as this key does not resolve via the

35541

composer and needs the backup of the default mechanism.

35542

35543

</dd>

35544

<dt> Full Example:</dt>

35545

<dd><table><tr><td> </td><td><pre class="example">ti[" "] = {"fl_sahara"}

35546

ti[" ="] = {"fl_tigris"}

35547

ti[" ."] = {"fl_abyss"}

35548

ti[" ~"] = {"fl_water"}

35549

ti[" ;"] = {"fl_lawn"}

35550

35551

ti["# "] = {"st_granite"}

35552

ti["W "] = {"st_wood"}

35553

ti["X "] = {"st_oxyd"}

35554

ti["G "] = {"st_grate_cross"}

35555

35556

ti["2 "] = {"it_coin_s"}

35557

ti["s "] = {"it_seed"}

35558

ti["c "] = {"it_cherry"}

35559

ti["h "] = {"it_hammer"}

35560

35561

ti["k "] = {"it_key"} .. ti({"st_lightglass"})

35562

35563

ti["xx"] = {"#ac_marble_black"}

35564

35565

local resolver = res.composer(ti)

35566

35567

w, h = wo(resolver, " ", {

35568

--0001020304050607080910111213141516171819

35569

" ",

35570

" h= ;W;2;c G~ ~# #.2.X X~k=k; ",

35571

" ",

35572

" 2;s; 2.s. 2=s= ",

35573

" c;h; c.h. c=h= xx ",

35574

" "

35575

})

35576

</pre></td></tr></table>

35577

35578

</dd>

35579

</dl>

35580

35581

35582

35583

35584

35585

35586

35587

35588

35589

35590

35591

35592

35593

35594

35595

35596

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

35597

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

35598

35599

</tr></table>

35600

35601

35602

35603

35604

The maze resolver supports you in the creation of quite arbitrary mazes. The

35605

shape is no longer limited to boring rectangular areas of one grid thick walls

35606

leaving the player just a one grid path uniquely connecting all parts of the maze.

35607

35608

This second generation maze generator lets you fill mazes in arbitrarily shaped

35609

areas, mazes with thick walls or chasms, or thin walls of just a sheet of window

35610

glass, mazes with cells of single grid, cells that are whole islands or mazes

35611

based on <a href="#it_005fstrip">it_strip</a> that have cells of no extent and consist of connections

35612

only. The maze cells may be aligned strictly rectangular or shifted in one

35613

direction, they may be just connected to its 4 neighbors or to 6 neighbors in

35614

hexagonal mazes or three dimensional mazes. You can write and plug in your own

35615

maze generation and rendering algorithms. And finally you can analyse,

35616

postprocess and even modify your maze even after the initial creation.

35617

35618

From the mathematical point of view we provide the basic structures for

35619

generation of quite arbitrary directed graphs. Our maze consists of cells, the

35620

vertices of a graph. Every cell can be connected to a given number of neighbor

35621

cells. But these connections, that are the passages from one cell to another,

35622

can even be direction dependent. This allows you to use window panes on either

35623

side of a connection or to use oneways for your connections, too. These passages

35624

from one cell to another are the edges of our graph and as they may be directed

35625

we have a directed graph. But for most mazes the support of directions is

35626

irrelevant and transparent, and you do not really need to know anything about

35627

graphs at all. Thus we called the resolver just a maze resolver.

35628

35629

Of course such a versatile resolver needs some configuration. As the parameters

35630

exceed the number of arguments, that you can reasonably supply to a function

35631

just by enlisting them, we decided to group the parameters for specific

35632

tasks and to use a table with named attributes for the configuration. This

35633

sounds more complex than it is. But watch out carefully for the table curly

35634

braces as they are necessary and can not be omitted.

35635

35636

In a big level you may want to generate two or even more completely independent

35637

mazes. You can do this by using multiple instances of this resolver. The

35638

resolver handle returned on the configuration is a unique reference pointer for

35639

the maze for subsequent requests. Store it and link all the maze resolvers as

35640

explained in <a href="#Resolver-Chaining">Resolver Chaining</a>.

35641

35642

35643

<dt> Location:</dt>

35644

<dd>This resolver is part of the library ‘<samp>libmaze</samp>’ as of release 2. You can

35645

use it by adding the following dependency to your level <a href="#g_t_003ccompatibility_003e"><compatibility></a>

35646

declaration:

35647

<table><tr><td> </td><td><pre class="example"> <el:dependency el:path="<var>lib/libmaze</var>" el:id="<var>lib/libmaze</var>" el:release="<var>2</var>" el:preload="<var>true</var>"/>

35648

</pre></td></tr></table>

35649

35650

The library <a href="#libmap">libmap</a> is automatically preloaded by this resolver.

35651

35652

</dd>

35653

<dt> Syntax:</dt>

35654

<dd>

35655

themaze = res.maze(subresolver, attributes)

35656

35657

35658

<dt> subresolver</dt>

35659

<dd>Resolver to which unresolved requests should be forwarded. May be ‘<samp>ti</samp>’

35660

as the final resolver of the resolver chain.

35661

</dd>

35662

<dt> attributes = {keyvalue, keyvalue,...}</dt>

35663

<dd>An anonymous table with one or many attributes given as key value pairs,

35664

separated by a comma.

35665

</dd>

35666

<dt> keyvalue = <area=area_value | render = render_value | kernel = kernel_value | spacing = spacing_value | persistent=persistence></dt>

35667

<dd>Values for given keys that may occur in any sequence in the anonymous table.

35668

</dd>

35669

<dt> area_value = {<rectangular_area | marked_area>}</dt>

35670

<dd>The maze area specification, that is either defined as an rectangular area

35671

or an area marked in the world’s map.

35672

</dd>

35673

<dt> rectangular_area = anchor, width, height</dt>

35674

<dd>An rectangular area that is given by an anchor position within the world and

35675

two numbers for the width and height measured in maze cells.

35676

</dd>

35677

<dt> anchor</dt>

35678

<dd>Anything that is convertible to a <a href="#Position">Position</a> that denotes the upper left

35679

edge of the rectangular maze area. Besides a position value, an object reference

35680

or a name string of an object or position are supported value types.

35681

</dd>

35682

<dt> marked_area</dt>

35683

<dd>One or multiple strings separated by a comma as simple entries in the anonymous

35684

table. Every string does either specify a key match, a key prefix or an object

35685

name. All these strings can be used at the same time for marking an area. The

35686

strings can occur in any sequence and multiplicity.

35687

</dd>

35688

<dt> kernel_value = {kernel_width, kernel_height}</dt>

35689

<dd>The size of the kernel of a cell given by width and height in number of grids.

35690

</dd>

35691

<dt> spacing_value = {spacing_x, spacing_y}</dt>

35692

<dd>The distance of the kernel of one cell to its neighbor in x and y direction

35693

measured in number of grids.

35694

</dd>

35695

<dt> render_value = {<std_renderer_args | other_renderer>}</dt>

35696

<dd>The specification for drawing the maze. In case of a missing specification

35697

no drawing will be done at all. If the default standard renderer should be used

35698

its parameters can be directly supplied, other renderers need a type

35699

specification plus the necessary configuration information.

35700

</dd>

35701

<dt> std_renderer_args = passage_keys [, <wall_key [, kernel_key] | cell_map>]]</dt>

35702

<dd>The standard renderer takes info about tile keys to be used for the passages,

35703

and either a cell map, or additional tile keys for the wall and optionally the

35704

kernel of a cell.

35705

</dd>

35706

<dt> passage_keys = <passage_key | {passage_open, passage_closed}></dt>

35707

<dd>Usually you just give a tile key for open maze passages. Closed passages appear

35708

like walls and use the same tile key. But in case you want to use special tile

35709

keys for open and for closed passages you can supply two strings in an

35710

anonymous table. If you give no wall key you may need to include an

35711

‘<samp>st_nil</samp>’ in your open passage tile declaration to kill a wall stone drawn

35712

by your world map.

35713

</dd>

35714

35715

<dd>The tile key to be used for drawing walls. If it is omitted no wall is drawn

35716

and the resolver relies on all possible wall tiles to be drawn by the world

35717

map itself.

35718

</dd>

35719

<dt> kernel_key</dt>

35720

<dd>In most cases the cell kernel will be drawn by the world map. But if not you

35721

can supply a tile key that will be drawn on every cell kernel grid.

35722

</dd>

35723

35724

<dd>Instead of kernel and wall tile keys you can supply a <a href="#libmap">libmap</a> map of a

35725

complete cell. The map can provide arbitrary tiles for cell kernels larger than

35726

a single grid. The walls can differ on the south and east side, too.

35727

</dd>

35728

<dt> other_renderer = renderer [, other_renderer_args]</dt>

35729

<dd>Enlisting of a renderer function followed by its specific arguments.

35730

</dd>

35731

<dt> renderer</dt>

35732

<dd>The function that does the rendering. By default it is

35733

‘<samp>lib.maze.renderer_standard</samp>’ with the above given arguments. Other supplied

35734

renderers are ‘<samp>lib.maze.renderer_window</samp>’ and

35735

‘<samp>lib.maze.renderer_strip</samp>’

35736

35737

35738

35739

35740

</dd>

35741

<dt> persistence</dt>

35742

<dd>A boolean flag that defaults to ‘<samp>false</samp>’. You need to set it to ‘<samp>true</samp>’

35743

if you want to access the maze or any of its cells after the level

35744

initialization. Otherwise the maze reference handle with all its data may get

35745

invalid due to memory garbage collection. This is no problem for most mazes,

35746

that will be directly rendered and have no need of further evaluation or changes

35747

during runtime.

35748

</dd>

35749

</dl>

35750

35751

</dd>

35752

<dt> Syntax Samples:</dt>

35753

<dd><table><tr><td> </td><td><pre class="example">maze1 = res.maze(ti, {area ={"anchor1", 4, 5}, render = {" ", "-", " "}})

35754

maze2 = res.maze(ti, {area ={"."}, kernel={1,1}, render = {"!", "~", "-"}})

35755

maze3 = res.maze(ti, {area ={"amaze#*"}, render = {{".","+"}, "~", "-"}})

35756

maze4 = res.maze(ti, {area ={po(2, 12), 5, 5}, kernel={3,2},

35757

render = {".", wo:newMap(" ", {"!!!~","--!~","~~~~"})}})

35758

</pre></td></tr></table>

35759

35760

</dd>

35761

<dt> Details:</dt>

35762

<dd>To be written.

35763

35764

35765

</dd>

35766

<dt> Full Example:</dt>

35767

</dl>

35768

35769

35770

35771

35772

35773

35774

35775

35776

35777

35778

35779

35780

35781

35782

35783

35784

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

35785

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

35786

35787

</tr></table>

35788

35789

<h3 class="subsection">13.1.6 res.puzzle</h3>

35790

35791

35792

The puzzle resolver helps you to reduce the number of required tile declarations

35793

for clusters of <a href="#st_005fpuzzle">st_puzzle</a> stones. By usage of the ‘<samp>cluster</samp>’ attribute

35794

of <a href="#st_005fpuzzle">st_puzzle</a> you can easily set clusters of fully connected stones. But

35795

for irregular, internally just partial connected puzzles you often need a bunch

35796

of similar tile declarations that differ just in the ‘<samp>connections</samp>’ attribute

35797

value.

35798

35799

<table><tr><td> </td><td><pre class="example">ti["B1"] = {"st_puzzle_blue", cluster=1}

35800

ti["Ba"] = {"st_puzzle_blue", connections="w"}

35801

ti["Bb"] = {"st_puzzle_blue", connections="sw"}

35802

ti["Bd"] = {"st_puzzle_blue", connections="ew"}

35803

ti["Bh"] = {"st_puzzle_blue", connections="n"}

35804

</pre></td></tr></table>

35805

35806

Like <a href="#res_002eautotile">res.autotile</a> this resolver offers autotiling. You just define one

35807

template tile and can use all connections variations

35808

35809

<table><tr><td> </td><td><pre class="example">ti["B"] = {"st_puzzle_blue"}

35810

</pre></td></tr></table>

35811

35812

Additionally this resolver registers every puzzle stone set and allows you to

35813

shuffle the puzzle clusters. You can even select shuffle algorithms and define

35814

accessible sides of a puzzle.

35815

35816

35817

<dt> Location:</dt>

35818

<dd>This resolver is part of the library ‘<samp>libpuzzle</samp>’ as of release 3. You can

35819

use it by adding the following dependency to your level <a href="#g_t_003ccompatibility_003e"><compatibility></a>

35820

declaration:

35821

<table><tr><td> </td><td><pre class="example"> <el:dependency el:path="<var>lib/libpuzzle</var>" el:id="<var>lib/libpuzzle</var>" el:release="<var>3</var>" el:preload="<var>true</var>"/>

35822

</pre></td></tr></table>

35823

35824

</dd>

35825

<dt> Syntax:</dt>

35826

<dd>

35827

res.puzzle(subresolver, rules)

35828

35829

35830

<dt> subresolver</dt>

35831

<dd>Resolver to which unresolved requests should be forwarded. May be ‘<samp>ti</samp>’

35832

as the final resolver of the resolver chain.

35833

</dd>

35834

<dt> rules = rule, rule,...</dt>

35835

<dd>One rule or as many as you like, all separated by a comma.

35836

</dd>

35837

35838

<dd>The string of the template tile key that is the common tile key prefix for all

35839

autogenerated tile declarations.

35840

</dd>

35841

</dl>

35842

35843

</dd>

35844

<dt> Syntax Samples:</dt>

35845

<dd><table><tr><td> </td><td><pre class="example">res.puzzle(ti, "B", "Y", "I", "M")

35846

</pre></td></tr></table>

35847

35848

</dd>

35849

<dt> Details:</dt>

35850

<dd>The puzzle resolver assumes a tile key length of two or more characters. The

35851

given rules are prefix strings which need concat with a one character suffix

35852

to a standard tile key. Given a rule with a proper template rule you can use

35853

any of the following suffices without tile declaration:

35854

35855

<table><tr><td> </td><td><pre class="example"> Suffix Cluster Connections

35856

Solid Hollow

35857

'0' '5' 0 autoconnect

35858

'1' '6' 1 autoconnect

35859

'2' '7' 2 autoconnect

35860

'3' '8' 3 autoconnect

35861

'4' '9' 4 autoconnect

35862

' ' '+' nil ""

35863

'a' 'A' nil "w"

35864

'b' 'B' nil "s"

35865

'c' 'C' nil "sw"

35866

'd' 'D' nil "e"

35867

'e' 'E' nil "ew"

35868

'f' 'F' nil "es"

35869

'g' 'G' nil "esw"

35870

'h' 'H' nil "n"

35871

'i' 'I' nil "nw"

35872

'j' 'J' nil "ns"

35873

'k' 'K' nil "nsw"

35874

'l' 'L' nil "ne"

35875

'm' 'M' nil "new"

35876

'n' 'N' nil "nes"

35877

'o' 'O' nil "nesw"

35878

'p' 'P' 10 autoconnect

35879

'q' 'Q' 11 autoconnect

35880

'r' 'R' 12 autoconnect

35881

's' 'S' 13 autoconnect

35882

't' 'T' 14 autoconnect

35883

'u' 'U' 15 autoconnect

35884

'v' 'V' 16 autoconnect

35885

'w' 'W' 17 autoconnect

35886

'x' 'X' 18 autoconnect

35887

'y' 'Y' 19 autoconnect

35888

'z' 'Z' 20 autoconnect

35889

</pre></td></tr></table>

35890

35891

All puzzle stones set by this resolver will be registered and shuffled by

35892

default with the ‘<samp>intensity</samp>’ of 3. You can define other intensity attribute

35893

values on any puzzle stone. The maximum intensity of all stones in a cluster

35894

will be taken. The intensity multiplied by the number of stones in a cluster

35895

describes the number of inverse pushes, called pulls, that will be performed

35896

during shuffling. Thus an intensity of 3 on a cluster of 6 stones will perform

35897

18 pulls. That means it is guaranteed that you can solve the puzzle with 18

35898

pushes. But as some pull operations may neutralize the user may be able to

35899

solve such a shuffled puzzle with less than 18 pushes.

35900

35901

If you define no shuffle ‘<samp>algorithm</samp>’ it is assumed that the user can

35902

rotate the puzzle from any side and any <a href="#st_005fpuzzle">st_puzzle</a>. The requested number

35903

of shuffling pull operations will be performed from random puzzle stones in a

35904

manner that guarantees that the user can solve the puzzle if he has free access

35905

to all sides.

35906

35907

If you set the ‘<samp>algorithm</samp>’ on any of the puzzle stones to the value

35908

<code>"marked"</code> the resolver registers that the user has no free access, but

35909

just from positions that you did mark. You do mark a position by setting

35910

the attribute <a href="#push_005fdirections">push_directions</a> on a floor. All floors adjacent to puzzle

35911

stones, including floors beneath another puzzle stone, will be checked for this

35912

attribute. It is your responsibility to mark all floors and to ensure that

35913

the player has continuos access to these foors for solving the puzzle by

35914

push rotations. The attribute takes a string value, a substring of <code>"nesw"</code>.

35915

If it contains the character of the required push direction this push event will

35916

take part in the random reverse shuffling process.

35917

35918

Note that hollow stones and their restriction of not being able to initiate a

35919

rotation if fully respected on shuffling.

35920

35921

</dd>

35922

<dt> Full Example:</dt>

35923

<dd><table><tr><td> </td><td><pre class="example">ti[" "] = {"fl_sahara"}

35924

ti["##"] = {"st_granite"}

35925

35926

ti[".."] = {"fl_sahara", push_directions="nesw"}

35927

35928

ti["B"] = {"st_puzzle_blue"}

35929

ti["Y"] = {"st_puzzle_yellow"}

35930

ti["I"] = {"st_puzzle_blue", intensity=2/6}

35931

ti["M"] = {"st_puzzle_blue", algorithm="marked", intensity=10}

35932

35933

ti["xx"] = {"#ac_marble_black"} ..ti({"it_magicwand"})

35934

35935

local resolver = res.puzzle(ti, "B", "Y", "I", "M")

35936

35937

w, h = wo(resolver, " ", {

35938

" ",

35939

"B1B1B1B1 ",

35940

"B2B1BjB1 Y1Y6Y1 ",

35941

"B2B2B2B2 Y1Y1YC ",

35942

" Y6YnY1 ",

35943

" ########## Y1Y1Y1 ",

35944

" ##M1M1M1## ",

35945

" I1I1 ##M1McM1.. ",

35946

" I6Ia ..M1M1M1.. xx ",

35947

" I1I1 ....#### ",

35948

" ",

35949

" ",

35950

" "

35951

})

35952

</pre></td></tr></table>

35953

</dd>

35954

</dl>

35955

35956

35957

35958

35959

35960

35961

35962

35963

35964

35965

35966

35967

35968

35969

35970

35971

35972

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

35973

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

35974

35975

</tr></table>

35976

35977

<h3 class="subsection">13.1.7 res.random</h3>

35978

35979

35980

With map based level description you have explicit control about the objects

35981

being set on every single grid. But sometimes you may want to introduce some

35982

randomness in the used objects. E.g. a floor may be made up of two types at

35983

random to generate a different look on every level start. The randomness would

35984

even make a level more difficult to play if one of the two floors would

35985

invert the mouse forces. The random resolver allows you to set up such

35986

cases.

35987

35988

35989

<dt> Syntax:</dt>

35990

<dd>

35991

res.random(subresolver, hits, replacements)

35992

35993

35994

<dt> subresolver</dt>

35995

<dd>Resolver to which unresolved requests should be forwarded. May be ‘<samp>ti</samp>’

35996

as the final resolver of the resolver chain.

35997

</dd>

35998

35999

<dd>Either a single tile key string that defines the tiles to be randomized, or a

36000

table of hit descriptors that should all be examined in parallel.

36001

</dd>

36002

<dt> hit = key | {key, superkey}</dt>

36003

<dd>Either a single tile key string or a pair of tile key string and a related

36004

tile superkey string. The superkey tile will be set additionally to the random

36005

replacement.

36006

</dd>

36007

<dt> replacements = key | {replacement, replacement, ...}</dt>

36008

<dd>Either a single tile key string that would be taken without randomness or as in

36009

most cases a table of replacement descriptors from which the resulting tile

36010

should be selected with randomness.

36011

</dd>

36012

<dt> replacement = key | {key, frequency}</dt>

36013

<dd>Either a single tile key string that should be taken with a frequency of ‘<samp>1</samp>’,

36014

or a pair of a tile key string with a given frequency number. The frequency can

36015

be an integer or non-integer number, but must be positive or zero.

36016

</dd>

36017

</dl>

36018

36019

</dd>

36020

<dt> Syntax Samples:</dt>

36021

<dd><table><tr><td> </td><td><pre class="example">res.random(ti, "x", {"a", "b"})

36022

res.random(ti, {{"x", "y"},{"i","j"}}, {{"a", 2}, {"b", 1}})

36023

</pre></td></tr></table>

36024

36025

</dd>

36026

<dt> Details:</dt>

36027

<dd>Every key in the map is checked against the given hit key strings. If it fits

36028

one of them a replacement will take place.

36029

36030

The replacement will be one of the replacement tile keys resolved via the

36031

subresolver. The different keys will be chosen with a likelihood according to

36032

the ratio of the given frequency numbers. If no frequency is supplied a default

36033

of ‘<samp>1</samp>’ is taken. Thus in the first example both keys are taken in a ratio

36034

1:1, whereas in the second the ratio will be 2:1.

36035

36036

When a superkey is given for a hit key this superkey will additionally be

36037

resolved via the subresolver. This feature allows to use randomness on tiles

36038

with more than one object on a grid position. E.g. an item or an actor on a

36039

random floor. The other objects can be set via the superkey while the random

36040

floor is set according to the replacement rules.

36041

36042

</dd>

36043

<dt> Full Example:</dt>

36044

<dd><table><tr><td> </td><td><pre class="example">ti["~"] = {"fl_water"}

36045

ti["s"] = {"fl_sahara"}

36046

ti["t"] = {"fl_tigris"}

36047

ti["i"] = {"fl_inverse_gray"}

36048

ti["b"] = {"fl_yinyang_yin"}

36049

ti["w"] = {"fl_yinyang_yang"}

36050

36051

ti["c"] = {"it_coin_s"}

36052

ti["p"] = {"it_brush"}

36053

36054

ti["1"] = {"ac_marble_black", 0, 0.5}

36055

36056

simple_random = res.random(ti, " ", {"s", "t"})

36057

36058

full_random = res.random(simple_random, {".",{"C","c"},{"p","p"}},

36059

{{"i",3},{"b",4},{"w",1}})

36060

36061

w, h = wo(full_random, "s", {

36062

" ~~.........",

36063

" ~~.........",

36064

" ~~......C..",

36065

" ~~.........",

36066

" ~~.........",

36067

" ~~.........",

36068

" c1.........",

36069

" ~~.........",

36070

" ~~.........",

36071

" ~~.........",

36072

" ~~......p..",

36073

" ~~.........",

36074

" ~~........."

36075

})

36076

</pre></td></tr></table>

36077

36078

Note that in this example we can use ‘<samp>p</samp>’ as key as well as superkey. This

36079

is due to the fact that nowhere else this tile is directly set. Whereas the

36080

tile key ‘<samp>c</samp>’ is used for another tile with the default floor. Thus we do

36081

need to use another unique key ‘<samp>C</samp>’ for the coin on our random floor.

36082

36083

</dd>

36084

</dl>

36085

36086

36087

36088

36089

36090

36091

36092

36093

36094

36095

36096

36097

36098

36099

36100

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

36101

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

36102

36103

</tr></table>

36104

36105

<h3 class="subsection">13.1.8 res.train</h3>

36106

36107

36108

The train resolver supports you in the set up of train like wandering floor

36109

chains. Usually short passages of solid standard floors wander on a closed

36110

path of otherwise unpassable floors like <a href="#fl_005fabyss">fl_abyss</a> or <a href="#fl_005fwater">fl_water</a>.

36111

36112

The path itself is called railway, even though the name train does not really

36113

fit the features of the wandering floor chains. But these names have been

36114

chosen by Petr Machata in his first implementation of a simple wandering floor

36115

feature.

36116

36117

In contrast to real world train, the wandering floors themselves do not move at

36118

all. Thus they do neither carry items or stones, nor do they allow an actor to

36119

rest on them and to be automatically transported along the path. The train

36120

is more like a curb wheel of a trunk. New floors are added to the front while

36121

trailing floors are removed.

36122

36123

Actually a chain of floors is composed of two train locos which move along the

36124

railway path. One at the front that sets floor of the standard passable kind and

36125

one at the end, or exactly one grid behind the end, that resets floor of the

36126

unpassable floor kind.

36127

36128

Usually both train locos move at the same speed keeping the passable floor

36129

chain length constant. But this resolver allows you to set up arbitrary

36130

number of train locos moving in arbitrary direction at arbitrary speed on a

36131

railway. But the resulting floor patterns will likely no longer behave like

36132

trains. Nevertheless we keep the name.

36133

36134

Every railway path has to be described by a chained train resolver instance. The

36135

paths of different resolvers may cross each other, but crossing trains may cause

36136

unexpected results as the train locos just set floors without any respect to

36137

other trains. In future it is planned to add track and train line attributes,

36138

which will allow even more complex railways.

36139

36140

36141

<dt> Syntax:</dt>

36142

<dd>

36143

res.train(subresolver[, suffix][, hits])

36144

36145

36146

<dt> subresolver</dt>

36147

<dd>Resolver to which unresolved requests should be forwarded. May be ‘<samp>ti</samp>’

36148

as the final resolver of the resolver chain.

36149

</dd>

36150

<dt> suffix</dt>

36151

<dd>An optional key suffix string. Every grid position with a matching key is

36152

registered as part of the railway path.

36153

</dd>

36154

36155

<dd>One or many resolver key hits that will identify positions of the railway path

36156

with optional trains located on them.

36157

</dd>

36158

<dt> hit = key | {key [, subkey][, edge=edgevalue][, train=trainvalue]}</dt>

36159

<dd>Either a single tile key string or a table of a tile key string with an optional

36160

related tile subkey string and optional further arguments.

36161

</dd>

36162

<dt> edgevalue</dt>

36163

<dd>A railway position that marks one of two edges spanning a rectangular railway

36164

path.

36165

</dd>

36166

<dt> trainvalue = {successorkey [, predecessorkey] [, length=trainlength] [, orientation=traveldirection] [, interval=speed] [, name=namevalue]}</dt>

36167

<dd>A train loco that moves with the given speed interval, defaulting to 0.25

36168

seconds per grid, and starting into the given traveldirection. The loco sets

36169

floors given by the sucessorkey string that will be resolved via the subresolver.

36170

If a trainlength is given, a second train loco is automatically created that

36171

preceeds this one by the given length. This front train loco will set floors

36172

defined by the predecessorkey string. If the train loco has an assigned name

36173

string, the front train loco will be named with an appended <code>"_front"</code>.

36174

</dd>

36175

</dl>

36176

36177

</dd>

36178

<dt> Syntax Samples:</dt>

36179

<dd><table><tr><td> </td><td><pre class="example">res.train(ti, ".", {" ^", train={" ~", " w", orientation=NORTH, length=6, interval=0.3}})

36180

res.train(ti, {"e", edge=true}, {">", train={" w", orientation=EAST}}, {"<", train={"~", orientation=WEST}})

36181

</pre></td></tr></table>

36182

36183

</dd>

36184

<dt> Details:</dt>

36185

<dd>Every key in the map is checked against the given hit key strings. If it fits

36186

one of them the positition is added to the railway path and the subkey is used

36187

to set remaining objects via the subresolver onto the grid. If no subkey is

36188

given no additional objects are set.

36189

36190

If the key is no hit, but a suffix string is given and matches the key, the

36191

position will be registered as part of the railway path, too. In this case

36192

the suffix part of the key will be replaced by space characters and the

36193

resulting key will be resolved via the subresolver.

36194

36195

There is no need of marking every grid position of a railway, what would be a

36196

very annoying task if many stones and items are positioned on its path. By

36197

default every train moves straight forward. You just need to provide hints for

36198

positions where the train turns left or right. Marking the positions of the path

36199

that follow every turn is sufficient.

36200

36201

36202

</dd>

36203

<dt> Full Example:</dt>

36204

<dd><table><tr><td> </td><td><pre class="example">ti[" "] = {"fl_sahara"}

36205

ti[" ~"] = {"fl_water"}

36206

ti[" w"] = {"fl_wood"}

36207

ti["# "] = {"st_rawglass"}

36208

ti[" @"] = {"#ac_marble"}

36209

36210

railway1 = res.train(ti, ".", {"1^", train={" ~", " w", orientation=NORTH, length=6}})

36211

railway2 = res.train(railway1, {"2e", edge=true}, {"2^", train={" ~", " w", orientation=NORTH, length=5}})

36212

36213

wo(railway2, " ", {

36214

" . ",

36215

" . ",

36216

" 1^ ",

36217

" @",

36218

" # ",

36219

" 2e ",

36220

" ",

36221

" ",

36222

" # #. 2^ ",

36223

" . ",

36224

" 2e ",

36225

" . ",

36226

" . "

36227

})

36228

</pre></td></tr></table>

36229

The first railway has just marked the essential positions that define the

36230

path.

36231

</dd>

36232

</dl>

36233

36234

36235

36236

36237

36238

36239

36240

36241

36242

36243

36244

36245

36246

36247

36248

36249

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

36250

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

36251

36252

</tr></table>

36253

36254

<h2 class="section">13.2 General Features</h2>

36255

36256

36257

<tr><td align="left" valign="top"><a href="#Display-Follow-Strategy">13.2.1 Display Follow Strategy</a></td><td>  </td><td align="left" valign="top"> How the display view follows the active marble

36258

</td></tr>

36259

<tr><td align="left" valign="top"><a href="#Flood-Spreading">13.2.2 Flood Spreading</a></td><td>  </td><td align="left" valign="top"> How a water flood spreads over a given area

36260

</td></tr>

36261

<tr><td align="left" valign="top"><a href="#Fire-Spreading">13.2.3 Fire Spreading</a></td><td>  </td><td align="left" valign="top"> How to start, use, and stop fire.

36262

</td></tr>

36263

<tr><td align="left" valign="top"><a href="#Heat_002dTransformation">13.2.4 Heat-Transformation</a></td><td>  </td><td align="left" valign="top"> How some floors transform when a fire starts nearby.

36264

</td></tr>

36265

<tr><td align="left" valign="top"><a href="#Freeze-Checking">13.2.5 Freeze Checking</a></td><td>  </td><td align="left" valign="top"> How to turn frozen boxes in a Sokoban to st_death.

36266

</td></tr>

36267

</table>

36268

36269

36270

36271

36272

36273

36274

36275

36276

36277

36278

36279

36280

36281

36282

36283

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

36284

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

36285

36286

</tr></table>

36287

36288

<h3 class="subsection">13.2.1 Display Follow Strategy</h3>

36289

36290

As the world can be larger than a display screen the active marble can move

36291

out of the area that is visible at level start. Somehow the display has to

36292

follow the active marble.

36293

36294

Whereas prior Enigma versions did provide just a handful of fixed modes, future

36295

versions will give you a much more detailed control of the display following

36296

strategy. We decided to switch the configuration to the future parameters

36297

already now. This allows us to give you some more follower control, even though

36298

some attributes are still limited in their values.

36299

36300

The strategy is described by the following parameters.

36301

36302

36303

<dt> Attributes:</dt>

36304

<dd>

36305

36306

<dt> <a href="#FollowGrid">FollowGrid</a></dt>

36307

<dt> <a href="#FollowMethod">FollowMethod</a></dt>

36308

<dt> <a href="#FollowThreshold">FollowThreshold</a></dt>

36309

<dt> <a href="#FollowAction">FollowAction</a></dt>

36310

</dl>

36311

36312

</dd>

36313

<dt> Syntax Samples:</dt>

36314

<dd><table><tr><td> </td><td><pre class="example">wo["FollowGrid"] = true

36315

wo["FollowMethod"] = FOLLOW_SCROLL

36316

</pre></td></tr></table>

36317

36318

</dd>

36319

<dt> Details:</dt>

36320

<dd>The attributes should always be set in the sequence as given above. This is due

36321

to the fact that the first attributes may reset some of the later attributes

36322

to matching defaults. This way you will have to set just a two attributes for

36323

the most common cases.

36324

36325

You can set the display follow strategy at any point. You are even allowed to

36326

switch the strategy during the running game.

36327

36328

</dd>

36329

<dt> Valid Configurations as of Enigma 1.10:</dt>

36330

<dd>

36331

36332

<dt> Screen Flipping:</dt>

36333

<dd><table><tr><td> </td><td><pre class="example">wo["FollowGrid"] = true

36334

wo["FollowMethod"] = FOLLOW_FLIP

36335

</pre></td></tr></table>

36336

The default strategy. The screen flips as soon as the marble reaches the outer

36337

half of the boundary grid tile. The screen moves by a full screen minus the

36338

common tile row or column.

36339

36340

</dd>

36341

<dt> Half Screen Scrolling:</dt>

36342

<dd><table><tr><td> </td><td><pre class="example">wo["FollowGrid"] = true

36343

wo["FollowMethod"] = FOLLOW_SCROLL

36344

wo["FollowAction"] = FOLLOW_HALFSCREEN

36345

</pre></td></tr></table>

36346

As soon as the marble reaches the outer half of the boundary grid tile the

36347

display scrolls pixel by pixel by half a screen. It realigns to the grid. As

36348

on a standard sized screen the display would have to scroll 9.5 grids in

36349

horizontal direction such scrolls will alternate in scrolls of 9 and 10 grids.

36350

The follower will try to stabilize the reachable scroll positions.

36351

36352

</dd>

36353

<dt> Permanent Smooth Scrolling:</dt>

36354

<dd><table><tr><td> </td><td><pre class="example">wo["FollowGrid"] = false

36355

wo["FollowMethod"] = FOLLOW_SCROLL

36356

</pre></td></tr></table>

36357

The active actor will always stay in the center of the screen. The display

36358

compensates the actor’s movement pixel by pixel by scrolling. The display

36359

positions are not aligned to grid tiles.

36360

36361

</dd>

36362

<dt> Full Screen Scrolling:</dt>

36363

<dd><table><tr><td> </td><td><pre class="example">wo["FollowGrid"] = true

36364

wo["FollowMethod"] = FOLLOW_SCROLL

36365

wo["FollowAction"] = FOLLOW_FULLSCREEN

36366

</pre></td></tr></table>

36367

As soon as the marble reaches the outer half of the boundary grid tile the

36368

display scrolls pixel by pixel by a full screen minus the common tile row or

36369

column.

36370

36371

</dd>

36372

<dt> No Screen Scrolling:</dt>

36373

<dd><table><tr><td> </td><td><pre class="example">wo["FollowMethod"] = FOLLOW_NO

36374

</pre></td></tr></table>

36375

No scrolling at all. Even if the active actor moves out of sight the display

36376

remains at its position.

36377

36378

</dd>

36379

<dt> Screen Flipping at a given threshold:</dt>

36380

<dd><table><tr><td> </td><td><pre class="example">wo["FollowGrid"] = true

36381

wo["FollowMethod"] = FOLLOW_FLIP

36382

wo["FollowThreshold"] = po(2.5, 1.5)

36383

</pre></td></tr></table>

36384

The screen flips as soon as the marble reaches the given distance to the screen

36385

boundary. The screen moves by a full screen minus twice the threshold distance.

36386

The final display realigns to the grid even on odd threshold distances.

36387

36388

</dd>

36389

<dt> Full Screen Scrolling at a given threshold:</dt>

36390

<dd><table><tr><td> </td><td><pre class="example">wo["FollowGrid"] = true

36391

wo["FollowMethod"] = FOLLOW_SCROLL

36392

wo["FollowThreshold"] = po(2.5, 1.5)

36393

</pre></td></tr></table>

36394

The screen scrolls as soon as the marble reaches the given distance to the screen

36395

boundary. The screen moves by a full screen minus twice the threshold distance.

36396

The final display realigns to the grid even on odd threshold distances.

36397

</dd>

36398

</dl>

36399

36400

</dd>

36401

</dl>

36402

36403

36404

36405

36406

36407

36408

36409

36410

36411

36412

36413

36414

36415

36416

36417

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

36418

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

36419

36420

</tr></table>

36421

36422

<h3 class="subsection">13.2.2 Flood Spreading</h3>

36423

36424

36425

A flood is active <a href="#fl_005fwater">fl_water</a> that, originating from a source, spreads over

36426

<a href="#floodable">floodable</a> areas. In contrast to a flood standard water is just static,

36427

its ‘<samp>state</samp>’ is ‘<samp>IDLE</samp>’ and it will not spread to adjacent floors. But

36428

a flood reaching a static water lake will cross it as a tsunami and continue

36429

actively spreading on all riparian zones.

36430

36431

You set up the area by adding the attribute <a href="#floodable">floodable</a> with value

36432

<code>true</code> on all its floors. Just <a href="#fl_005fwater">fl_water</a> and the framed variants of

36433

<a href="#fl_005fwood">fl_wood</a>, <a href="#fl_005fhay">fl_hay</a> and <a href="#fl_005frock">fl_rock</a> do not require to be explicitly

36434

marked floodable as they are floodable by default. The marked area is the

36435

maximum area that may be flooded. But obstacles may block the flood temporarily

36436

or permanently.

36437

36438

A flood starts at a source. As soon as you add a ‘<samp>fl_water_source</samp>’ or set

36439

the ‘<samp>state</samp>’ to ‘<samp>FLOODING</samp>’, the <a href="#fl_005fwater">fl_water</a> starts to spread to

36440

floodable neighboring grids with a speed defined by the attribute

36441

‘<samp>interval</samp>’. The speed will be inherited to floors flooded by the stream.

36442

36443

Floodable floors with solid stones, closed doors or <a href="#st_005fwindow">st_window</a> with

36444

blocking faces on top will keep the flood from spreading to their grid position

36445

or if already flooded to spread to a neighboring grid. But as soon as the

36446

obstacle vanishes, e.g. an <a href="#st_005fdoor">st_door</a> opens, the flood continues to spread.

36447

Hollow stones, especially <a href="#st_005foneway">st_oneway</a> do not block flood streams, totally

36448

independent of actor blocking features on certain types or faces.

36449

36450

Of special interest are the <a href="#st_005fbox">st_box</a> variants and their successor floors,

36451

the framed variants of <a href="#fl_005fwood">fl_wood</a>, <a href="#fl_005fhay">fl_hay</a> and <a href="#fl_005frock">fl_rock</a>. A flood

36452

will flow beneath a box stone, if the floor beneath is floodable. In consequence

36453

of the upcoming water, the box stone will fall and build a framed floor of the

36454

given kind. These floors act like bridges over flooding water. They still let

36455

the flood spread to further neighboring floodable floors. Thus a user can not

36456

stop a flood by pushing an <a href="#st_005fbox">st_box</a> onto its path, but he can make the water

36457

passable for his marbles. In fact this framed floors can even operate as a flood

36458

source, but we do not recommend this usage.

36459

36460

In contrast to these floor building stones the <a href="#st_005fpuzzle">st_puzzle</a> does neither

36461

fall on static nor on flooding <a href="#fl_005fwater">fl_water</a>. As a solid stone it will even

36462

block a flood on neighboring grids to reach its position. But of course once

36463

moved completely over <a href="#fl_005fwater">fl_water</a> the puzzle will fall if its own conditions

36464

are met. The successor <a href="#fl_005fgray">fl_gray</a> will not build a bridge over water. It

36465

fills up the ditch and replaces the water completely. Thus the user can use

36466

puzzles to stop a flood.

36467

36468

When a flood stream spreads to a new floor items on these floors may be affected.

36469

E.g. <a href="#it_005fcrack">it_crack</a> get flooded and do vanish. All <a href="#it_005fburnable">it_burnable</a> besides oil

36470

get wiped out, too.

36471

36472

Further active components of the flood concept are <a href="#it_005fvortex">it_vortex</a> and

36473

<a href="#it_005fwormhole">it_wormhole</a>. Besides actors both do spread a flood. The <a href="#it_005fwormhole">it_wormhole</a>

36474

spreads the flood to its ‘<samp>destination</samp>’ if the floor at this grid is marked

36475

‘<samp>floodable</samp>’. An <a href="#it_005fvortex">it_vortex</a> will flood all its ‘<samp>destination</samp>’s,

36476

but of course just if it is in state ‘<samp>OPEN</samp>’. In case the destinations are

36477

vortices, too, they must be open, too, for a successful flood spreading. When the

36478

last closed vortex on either end opens again the hold flood continues to spread.

36479

Note that in these cases the flood reaches the destination grid from beneath.

36480

Thus no stone will block the emerging water. But nevertheless a stone on the

36481

destination position may well block the water from spreading to the neighboring

36482

grids.

36483

36484

Be aware that the Enigma flood has some extraordinary features. The most

36485

important is the ability to spread unlimitedly from every grid that got flooded,

36486

independently of a still existing connection to the flood source. Thus once a

36487

door is opened and a bit of the flood passes the door, the flood will continue

36488

to spread even if the door closes again. Same is true for toggling vortices or

36489

puzzle stones being pushed into a flood building a complete bridge over the

36490

water stream. But this feature is intentionally, as it avoids many shortcut

36491

situations and thus makes the flood more usable for level authors.

36492

36493

36494

36495

36496

36497

36498

36499

36500

36501

36502

36503

36504

36505

36506

36507

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

36508

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

36509

36510

</tr></table>

36511

36512

<h3 class="subsection">13.2.3 Fire Spreading</h3>

36513

36514

The 1.0-version of Enigma introduced a new fire system, making use of

36515

attributes and messages of the floor tiles. The default fire, once

36516

ignited, spreads over the landscape and destroys items, marbles and

36517

some stones. It spreads along those floor tiles that are marked “burnable” by

36518

default (like <a href="#fl_005fhay">fl_hay</a> or <a href="#fl_005fwood">fl_wood</a>), by attribute (see attribute

36519

<a href="#burnable">burnable</a>), or by one of two items that indicate burnability: the invisible

36520

<a href="#it_005fburnable">it_burnable</a> and the visible <code>it_burnable_oil</code>. On a burning floor,

36521

all items are destroyed. However, some items prevent the floor from burning,

36522

like <a href="#it_005fmeditation">it_meditation</a> or <a href="#it_005fdynamite">it_dynamite</a> (which ignites instead).

36523

36524

Fire can be ignited in several standard ways:

36525

<ul>

36526

<li> The <code>setfire</code>-message sets fire to a floor if it is

36527

burnable and the item on it allows it to burn; non-burnable items like

36528

<a href="#it_005fdynamite">it_dynamite</a> are not ignited by this.

36529

</li><li> The <code>heat</code>-message ignites burnable floors as does

36530

<code>setfire</code>, but also initiates a <a href="#Heat_002dTransformation">Heat-Transformation</a> of the floor

36531

and ignites items on it.

36532

</li><li> The <code>ignite</code> and <code>explosion</code>-messages that are used by

36533

<a href="#it_005fdynamite">it_dynamite</a> and <a href="#it_005fbomb">it_bomb</a> can initiate fire via

36534

<a href="#it_005fburnable">it_burnable</a>[_oil] or if the

36535

<a href="#ignitable">ignitable</a>-attribute of the floor is set (off by default).

36536

</li><li> The floor already starts burning on initialization when the

36537

<code>initfire</code>-attribute is set (off by default).

36538

</li><li> Fire in the neighborhood, see below.

36539

</li></ul>

36540

36541

If needed, the <code>forcefire</code>-message can be used to set fire to

36542

non-burnable floors. Internally, it is equivalent to manually setting

36543

<code>it_burnable_ignited</code>; however, setting <code>it_burnable_ignited</code>

36544

manually is deprecated to allow a further development of the fire-system in

36545

future.

36546

36547

Fire does the following:

36548

<ul>

36549

<li> It kills <a href="#st_005fbox">st_box</a>_wood, <a href="#st_005fbox">st_box</a>_hay, and <a href="#st_005fflat">st_flat</a>_moveburnable

36550

above it, and <a href="#st_005fflat">st_flat</a>_burnable beneath it.

36551

</li><li> It melts <a href="#st_005fice">st_ice</a> to <a href="#fl_005fwater">fl_water</a>.

36552

</li><li> It heats its neighboring tiles, which might result in a

36553

<a href="#Heat_002dTransformation">Heat-Transformation</a> of the floor.

36554

</li><li> It might ignite or destroy items on its neighbor, this concerns

36555

<a href="#it_005fdynamite">it_dynamite</a>, both <a href="#it_005fbomb">it_bomb</a>, and <a href="#it_005fcrack">it_crack</a>.

36556

</li><li> It might set fire to its neighbor.

36557

</li><li> It shatters marbles that are not protected with <a href="#it_005fumbrella">it_umbrella</a> or other

36558

measures. Note that in future versions, jumping over fire with <a href="#it_005fspring">it_spring</a>

36559

might get allowed.

36560

</li></ul>

36561

36562

Fire stops burning after a random amount of time, as long as the

36563

<code>eternal</code>-attribute of the floor is not set. When it stops

36564

burning, it might replace the floor by another kind

36565

(“fire-transform”), this is: <a href="#fl_005fwood">fl_wood</a> is replaced by

36566

<a href="#fl_005fabyss">fl_abyss</a>, <a href="#fl_005flawn">fl_lawn</a> by <a href="#fl_005fdunes">fl_dunes</a>. Finally, it

36567

puts <a href="#it_005fburnable">it_burnable</a>_ash on the floor, which prohibits a second

36568

fire and which can be removed with <a href="#it_005fbrush">it_brush</a>. However, ash is not

36569

set if the <a href="#noash">noash</a>-attribute is set (default only for <a href="#fl_005fabyss">fl_abyss</a>).

36570

36571

Since the spreading of fire is a random event, in 0.92, a level author couldn’t

36572

be sure that a particular item was ignited or fire was set. Since 1.0, these can

36573

be assured by setting the <a href="#secure">secure</a>-attribute: When a burnable floor with

36574

<code>secure = true</code> is near fire, it will eventually catch fire, items on it

36575

are ignited, etc. <code>secure</code> is <code>false</code> by default.

36576

36577

In 0.92, there were two speeds of fire: When using <a href="#it_005fburnable">it_burnable</a>,

36578

fire spread much faster than without. This is still the same in

36579

1.0 and above. However, you can set the <a href="#fastfire">fastfire</a>-attribute to hasten

36580

the fire without setting the invisible <a href="#it_005fburnable">it_burnable</a>, this should be the

36581

preferred method.

36582

36583

Fire that burns under a stone is not allowed to spread; the only exceptions are

36584

floating stones like <a href="#st_005fgrate">st_grate</a>, and those stones that are destroyed by fire

36585

anyway (<a href="#st_005fbox">st_box</a>_wood, <a href="#st_005fbox">st_box</a>_hay, <a href="#st_005fflat">st_flat</a>_burnable,

36586

<a href="#st_005fflat">st_flat</a>_moveburnable). In contrast to this, fire might also spread to

36587

under a movable stone, but not further.

36588

36589

You can stop fire with <code>it_extinguisher</code>, which creates the fireproof

36590

<code>it_burnable_fireproof</code>. Another way to stop fire is to push the totally

36591

inert <a href="#st_005fbox">st_box</a>_rock over it: This is the only movable stone that doesn’t

36592

allow fire under it. A final way to stop fire is to send the

36593

<code>stopfire</code>-message to a floor.

36594

36595

Differences between 1.0 and 0.92

36596

36597

The old fire system of Enigma versions up to 0.92, differs from

36598

the 1.0 and above version mainly in the following points:

36599

36600

<ul>

36601

<li> no fire-transform except <a href="#fl_005fwood">fl_wood</a> to <a href="#fl_005fabyss">fl_abyss</a>

36602

</li><li> no <a href="#Heat_002dTransformation">Heat-Transformation</a>s

36603

</li><li> ash on <a href="#fl_005fabyss">fl_abyss</a>

36604

</li><li> no difference between different floors

36605

</li><li> replication via same-floor-pattern instead of

36606

burnable-floor-pattern: 0.92 didn’t distinguish between burnable and

36607

non-burnable floors. Instead, fire was allowed to spread to floors of

36608

the same kind slowly.

36609

</li><li> burnable items always catch fire: In 1.0 and above, a burnable item

36610

(except for <a href="#it_005fburnable">it_burnable</a>[_oil]) on a non-burnable floor won’t catch fire,

36611

in 0.92 it did.

36612

</li></ul>

36613

36614

A good model of the 0.92-system can be attained via the

36615

compatibility-modes: All non-Enigma-modes (see section <a href="#Engine-Compatibility">Engine Compatibility</a> and

36616

<a href="#g_t_003ccompatibility_003e"><compatibility></a>) feature a version which only marginally differs from

36617

0.92-fire, yet allowing some of the new achievements, like secure- or

36618

eternal-fire.

36619

36620

Note that in 0.92, fire-transformation happened at the beginning of

36621

the fire, which manifested in the so called “burning-abyss”-bug.

36622

Besides other details, this is how the original 0.92 system differs from the

36623

one in 1.0-non-Enigma-mode.

36624

36625

Burnable and Fireproof Floors

36626

36627

All floors that look like plastic, fabrics, or organics are burnable by default:

36628

<code>fl_adhesionless, fl_aquamarine, fl_bluegray, fl_bluegreen, fl_blueslab,

36629

fl_fake_trigger, fl_hay, fl_ivory, fl_marble, fl_platinum, fl_red, fl_redslab,

36630

fl_rough*, fl_tigris, fl_woven</code>.

36631

36632

All floors that look like wood are burnable and leave <a href="#fl_005fabyss">fl_abyss</a> behind:

36633

<code>fl_bast, fl_plank, fl_samba*, fl_wood*</code>, and <a href="#fl_005fbridge">fl_bridge</a>_b*.

36634

36635

All floors that look like grass are burnable and leave <a href="#fl_005fdunes">fl_dunes</a> behind:

36636

<a href="#fl_005flawn">fl_lawn</a>.

36637

36638

All other floors are fireproof (they don’t burn by default):

36639

<code>fl_abyss*, fl_brick, fl_bright, fl_concrete, fl_dark, fl_darkgray,

36640

fl_dummy, fl_dunes, fl_gravel, fl_gray, fl_himalaya, fl_ice, fl_inverse*,

36641

fl_metal*, fl_mortar, fl_pinkbumps, fl_rock, fl_sahara, fl_sand, fl_slope*,

36642

fl_space, fl_stone, fl_swamp, fl_water, fl_white, fl_yinyang*</code>, and

36643

<a href="#fl_005fbridge">fl_bridge</a>_g*.

36644

36645

An open <a href="#fl_005fbridge">fl_bridge</a> is never burnable, this overrides all items and

36646

attributes. A closed <a href="#fl_005fbridge">fl_bridge</a> is burnable if and only if it is brown,

36647

but this can be changed via attribute <code>burnable</code>. Note that changing the

36648

flavor of <a href="#fl_005fbridge">fl_bridge</a> will change <code>burnable</code> according to the new

36649

flavor as well.

36650

36651

Fireproof Items

36652

36653

Most items are passively burnable, this is: An item is destroyed by

36654

fire, if and only if the floor could burn all by itself. However,

36655

there are some items with individual reactions (<code>it_burnable,

36656

it_burnable_oil, it_dynamite, it_bomb*, it_crack*</code>)

36657

and some items that are completely fireproof. These are: <code>it_burnable_ash,

36658

it_burnable_fireproof, it_debris, it_dummy, it_explosion*, it_extinguisher,

36659

it_extinguisher_medium, it_meditation*, it_trap, it_vortex*</code> and the fire

36660

animations themselves: <code>it_burnable_ignited</code> and

36661

<code>it_burnable_burning</code>.

36662

36663

Note that <code>it_extinguisher_empty, it_trigger</code> (visible and invisible),

36664

<code>it_landmine</code>, and <code>it_death</code> are passively burnable. In particular,

36665

<code>it_landmine</code> does not explode or create <code>it_meditation</code> when burning.

36666

The reaction of <a href="#it_005fsensor">it_sensor</a> towards fire might be changed in future

36667

versions.

36668

36669

If you need to save a passively burnable item from fire, simply set a fireproof

36670

floor like <code>fl_sand</code> or <code>fl_rock</code> below it. This normally is the case

36671

when using <a href="#it_005fstrip">it_strip</a>. However, you can use the <code>burnable</code>-attribute in

36672

these cases to force burnability of the floors.

36673

36674

36675

36676

36677

36678

36679

36680

36681

36682

36683

36684

36685

36686

36687

36688

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

36689

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

36690

36691

</tr></table>

36692

36693

<h3 class="subsection">13.2.4 Heat-Transformation</h3>

36694

36695

When a fire starts to burn near <a href="#fl_005fice">fl_ice</a>, it melts to <a href="#fl_005fwater">fl_water</a>. In the

36696

same sense, <a href="#fl_005fwater">fl_water</a> boils to <a href="#fl_005fswamp">fl_swamp</a>, and this again to

36697

<a href="#fl_005fdunes">fl_dunes</a>. In contrast to most other fire-related actions, this is not

36698

random, but always and only happens, when a nearby fire starts to burn, i.e.

36699

once for each new fire.

36700

36701

Examples: Put an <a href="#st_005fbox">st_box</a>_rock on <a href="#fl_005fice">fl_ice</a>. A fire will melt

36702

the ice, and <a href="#st_005fbox">st_box</a>_rock creates a fireproof and safe way to the

36703

other side. If you use <a href="#st_005fbox">st_box</a>_wood instead, <a href="#fl_005fwood">fl_wood</a>_framed is

36704

created, which presumably catches fire and leaves <a href="#fl_005fabyss">fl_abyss</a>

36705

behind. Finally, <a href="#st_005fbox">st_box</a>_hay will create <a href="#fl_005fhay">fl_hay</a>_framed, which is

36706

burnable, but won’t burn down to <a href="#fl_005fabyss">fl_abyss</a>. A similar combination is

36707

<code>fl_water</code> with <a href="#st_005fchess">st_chess</a>.

36708

36709

You can enforce a transformation by sending the <code>heat</code>-message to the

36710

floor.

36711

36712

If you want to suppress this transformation, you can switch to

36713

a non-Enigma-compatibility-mode.

36714

36715

36716

36717

36718

36719

36720

36721

36722

36723

36724

36725

36726

36727

36728

36729

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

36730

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

36731

36732

</tr></table>

36733

36734

<h3 class="subsection">13.2.5 Freeze Checking</h3>

36735

36736

With Enigma 1.1 and above, you can use a special feature to support Sokoban

36737

levels and Sokoban parts of levels: Whenever a movable stone is pushed into

36738

some unmovable position, this feature automatically transforms the stone into

36739

<a href="#st_005fdeath">st_death</a>, to demonstrate that the game is lost and provide a simple way

36740

for the player to restart.

36741

36742

The feature is called “Freeze Checking”. It applies to each stone with

36743

attribute <code>freeze_check = true</code> which is pushed onto a floor with

36744

attribute <code>freeze_check = true</code>. This way you can restrict the freeze

36745

check to a bounded area. For a true Sokoban the goal tiles should not be marked

36746

with <code>freeze_check = true</code>, as a frozen box on a goal is not considered

36747

harmful. On the other hand, you can specify which boxes are freeze-checked. This

36748

gives further freedom to use other stones inside your Sokoban area: Floor and

36749

stone both need the <code>freeze_check</code>-attribute activated.

36750

36751

The freeze check recognizes three basic constellations of stones that lead to a

36752

freeze of a standard movable stone. With <code>B</code> as box (movable or

36753

persistent) and <code>#</code> as wall (persistent):

36754

<table><tr><td> </td><td><pre class="example">BB #B #B

36755

BB # B#

36756

</pre></td></tr></table>

36757

There are more freeze constellations which are not recognized, the simplest

36758

would be:

36759

<table><tr><td> </td><td><pre class="example">#B

36760

BB

36761

#

36762

</pre></td></tr></table>

36763

Don’t rely on this fact, it might be changed in future versions.

36764

36765

Please bear in mind: The freeze check is not intelligent. It can’t foresee that

36766

one of your functions might remove a stone, it can’t foresee that some door

36767

will never open up again (doors are considered as non-existent), it doesn’t

36768

recognize when you put an <a href="#it_005fpuller">it_puller</a>, <a href="#it_005fcherry">it_cherry</a>, or <a href="#st_005fswap">st_swap</a> in

36769

your level. It handles special stones in a way to minimize false-positive freeze

36770

checks.

36771

36772

Floating stones (like <a href="#st_005fgrate">st_grate</a>) create completely new frozen

36773

constellations. From the following two examples, only the right example is

36774

frozen (<code>G</code> is <code>st_grate_cross</code>):

36775

<table><tr><td> </td><td><pre class="example">G G

36776

BB BB

36777

GB GBG

36778

</pre></td></tr></table>

36779

At present, none of these are recognized as frozen by Enigma, floating stones

36780

are considered as non-existing during a freeze check. To demonstrate the

36781

difficulty, you may analyze yourself which of the following constellations is

36782

frozen:

36783

<table><tr><td> </td><td><pre class="example">G G GBG GB# G G#G

36784

B# BBB BB GB G BBBBB

36785

G #B B# #B G G#G G

36786

G G G

36787

</pre></td></tr></table>

36788

36789

In some cases, stones are even handled differently although they have similar

36790

properties: <a href="#st_005fbox">st_box</a>_wood and <code>st_flat_moveburnable</code> (see

36791

<a href="#st_005fflat">st_flat</a>) are both movable and both destroyed by fire (see <a href="#Fire-Spreading">Fire Spreading</a>). There would never be frozen stones, as they can easily be burned

36792

away. Yet, <code>st_box_wood</code> uses the default freeze checking, whereas

36793

<code>st_flat_moveburnable</code> is considered as non-existing. This is because

36794

<code>st_box_wood</code> is often used without fire, whereas

36795

<code>st_flat_moveburnable</code> is primarily used in combination with fire.

36796

36797

Another example is <a href="#st_005fshogun">st_shogun</a>_s, which is considered as a default

36798

movable stone, in contrast to the remaining shogun stones. This way you can use

36799

<code>st_shogun_s</code> with goal <a href="#it_005fshogun">it_shogun</a>_s, but don’t have to fear

36800

false-positive freeze checks from the non-standard way in which shogun stones

36801

move.

36802

36803

As a concluding remark, the freeze checking is to be used as a support for the

36804

gamer only. It’s not meant to be exploited as special feature to make movable

36805

stones unmovable or to provide a way to jump back to the starting position. It

36806

is subject to changes in future versions. And versions before 1.1 won’t make a

36807

freeze check at all - so you can’t rely on it to happen. It should really be

36808

used in Sokoban-kind parts of a level only, for which it is designed.

36809

36810

36811

36812

36813

36814

36815

36816

36817

36818

36819

36820

36821

36822

36823

36824

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

36825

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

36826

36827

</tr></table>

36828

36829

<h2 class="section">13.3 Tips and Tricks</h2>

36830

36831

36832

<tr><td align="left" valign="top"><a href="#Nearest-Object-Clustering">13.3.1 Nearest Object Clustering</a></td><td>  </td><td align="left" valign="top"> When nearest object address wrong target

36833

</td></tr>

36834

<tr><td align="left" valign="top"><a href="#Orthogonal-Autotiling">13.3.2 Orthogonal Autotiling</a></td><td>  </td><td align="left" valign="top"> Autotiling with different sources and targets

36835

</td></tr>

36836

</table>

36837

36838

36839

36840

36841

36842

36843

36844

36845

36846

36847

36848

36849

36850

36851

36852

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

36853

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

36854

36855

</tr></table>

36856

36857

<h3 class="subsection">13.3.1 Nearest Object Clustering</h3>

36858

36859

The nearest object as described in <a href="#Object-Naming">Object Naming</a> provides a major feature

36860

for reducing the number of needed tile declarations. As the selection needs

36861

to be unique a rule had to be defined in case of equal distances. South wins,

36862

then east, stones are favored to items, floors and actors.

36863

36864

In most cases level authors can arrange their objects to fit these rules. But

36865

sometimes the level design does not allow the straight forward usage of a

36866

simple nearest object selection. E.g.

36867

36868

<table><tr><td> </td><td><pre class="example">ti["F"] = {"st_floppy", target="@door#*"}

36869

ti["B"] = {"st_blocker", name="door#"}

36870

wo{ti, " ", {

36871

" B ",

36872

" FB#####FB####",

36873

" # F B ",

36874

" # # F#####",

36875

</pre></td></tr></table>

36876

36877

In both cases the floppy switch that is located at the crossing of two blocker

36878

doors will open the false one.

36879

36880

But you can use a cluster concept like the one we introduced for

36881

<a href="#Cluster-Stones">Cluster Stones</a>. Just add one or in rare cases two or three additional

36882

groups. Assign all standard cases to group A and the out of line cases in

36883

group B:

36884

36885

<table><tr><td> </td><td><pre class="example">ti["F"] = {"st_floppy", target="@doorA#*"}

36886

ti["B"] = {"st_blocker", name="doorA#"}

36887

ti["f"] = {"st_floppy", target="@doorB#*"}

36888

ti["b"] = {"st_blocker", name="doorB#"}

36889

wo{ti, " ", {

36890

" b ",

36891

" fB#####fb####",

36892

" # F B ",

36893

" # # F#####",

36894

</pre></td></tr></table>

36895

36896

By clustering the doors in two groups you just need two additional tile

36897

declarations. But you will likely be able to handle a dozen of additional

36898

switch/door combinations.

36899

36900

36901

36902

36903

36904

36905

36906

36907

36908

36909

36910

36911

36912

36913

36914

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

36915

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

36916

36917

</tr></table>

36918

36919

<h3 class="subsection">13.3.2 Orthogonal Autotiling</h3>

36920

36921

Autotiling is useful whenever you want to define lots of

36922

target-action-pairings, even when source and target objects differ (i.e. use

36923

different tile keys). In this case we speak of ‘<samp>orthogonal autotiling</samp>’.

36924

Let’s take a look at the important parts of the API 2 version of the level

36925

‘<samp>Laser Games</samp>’:

36926

36927

<table><tr><td> </td><td><pre class="example">...

36928

ti["T*"] = {"it_trigger", target = "mirror%%", action_1 = "turn", action_0 = "turnback"}

36929

ti["F*"] = {"st_fourswitch", target = "mirror%%"}

36930

ti["1*"] = {"st_mirror", name = "mirror%%", flavor = "triangle", orientation = NORTH}

36931

ti["2*"] = {"st_mirror", name = "mirror%%", flavor = "triangle", orientation = SOUTH}

36932

ti["3*"] = {"st_mirror", name = "mirror%%", orientation = NORTH}

36933

...

36934

36935

local resolver = res.autotile(ti, {"T", "T*"}, {"F", "F*"},

36936

{"1", "1*"}, {"2", "2*"}, {"3", "3*"}, {"4", "4*"}, {"5", "5*"},

36937

{"6", "6*"}, {"7", "7*"}, {"8", "8*"}, {"9", "9*"})

36938

36939

w, h = wo(resolver, " ", {

36940

"# # # # # # # # # # # $ # $ # $ # $ # # ",

36941

"# # # ",

36942

"# = = # 1a 9b 3c 2d $ ",

36943

"# = # # ",

36944

"# TaTbTcTd # 3e 4f 5g 4h $ ",

36945

"# TeFfFgTh # # ",

36946

"# TiFjFkTl # 6i 3j 4k 7l $ ",

36947

"# TmFnFoTp # # ",

36948

"# TqTrTsTt # 8m 7n 6o 8p $ ",

36949

"# # # ",

36950

"# @ = # 1q 7r 3s 2t $ ",

36951

"# # # ",

36952

"# # # # # # # # # # # $ # $ # $ # ^ # # "

36953

})

36954

...

36955

</pre></td></tr></table>

36956

36957

We have different kinds of sources for our actions (triggers <code>T</code> and

36958

fourswitchs <code>F</code>), and different kinds of targets (mirrors <code>1</code>,

36959

<code>2</code> etc.). However, as all mirrors are consistently named <code>mirror%%</code>,

36960

with <code>%%</code> being replaced by <code>%a</code> to <code>%t</code>, the connections

36961

between the objects can be set easily without having to worry about different

36962

object types: The trigger <code>Ta</code> will turn mirror <code>1a</code> (which is called

36963

<code>mirror%a</code>), <code>Tb</code> will turn <code>9b</code> and so on. If we decide to

36964

replace mirror <code>1a</code> by, say, mirror type <code>2</code>, we can simply replace

36965

<code>1a</code> by <code>2a</code>, and still preserve the action-target-pairing.

36966

36967

In this very special situation, the attribute <code>counterclock</code> proves to

36968

be useful: All mirrors in this level turn clockwise, except for <code>9b</code>.

36969

Without <code>counterclock</code>, we’d have to use a callback-function to decide

36970

about the target and manually choose between the actions <code>turn</code> and

36971

<code>turnback</code>. However, by setting

36972

36973

<table><tr><td> </td><td><pre class="example">ti["9*"] = {"st_mirror", name = "mirror%%", flavor = "triangle",

36974

orientation = SOUTH, counterclock = true}

36975

</pre></td></tr></table>

36976

36977

it’s possible to send the same messages to all mirrors that correspond to

36978

triggers (i.e. <code>turn</code> when the trigger is pressed down and <code>turnback</code>

36979

when it is released again), and still to have one or more mirrors behave in a

36980

different way (i.e. rotating in another direction). The <code>inverse</code>

36981

attribute is of a similar use.

36982

36983

36984

36985

36986

36987

36988

36989

36990

36991

36992

36993

36994

36995

36996

36997

36998

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

36999

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

37000

37001

</tr></table>

37002

37003

<h1 class="chapter">14. Extension Development</h1>

37004

37005

37006

<tr><td align="left" valign="top"><a href="#Resolver-Development">14.1 Resolver Development</a></td><td>  </td><td align="left" valign="top">

37007

</td></tr>

37008

</table>

37009

37010

37011

37012

37013

37014

37015

37016

37017

37018

37019

37020

37021

37022

37023

37024

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

37025

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

37026

37027

</tr></table>

37028

37029

<h2 class="section">14.1 Resolver Development</h2>

37030

37031

Resolvers are designed to provide easy plugable extensions for usage by level

37032

authors. Further on resolvers should be as flexible as possible. To reach these

37033

goals each resolver consists of three parts: the configurator, the implemention

37034

and the finalizer.

37035

37036

37037

<tr><td align="left" valign="top"><a href="#Resolver-Configurator">14.1.1 Resolver Configurator</a></td><td>  </td><td align="left" valign="top">

37038

</td></tr>

37039

<tr><td align="left" valign="top"><a href="#Resolver-Implementation">14.1.2 Resolver Implementation</a></td><td>  </td><td align="left" valign="top">

37040

</td></tr>

37041

<tr><td align="left" valign="top"><a href="#Resolver-Finalizer">14.1.3 Resolver Finalizer</a></td><td>  </td><td align="left" valign="top">

37042

</td></tr>

37043

</table>

37044

37045

37046

37047

37048

37049

37050

37051

37052

37053

37054

37055

37056

37057

37058

37059

37060

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

37061

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

37062

37063

</tr></table>

37064

37065

<h3 class="subsection">14.1.1 Resolver Configurator</h3>

37066

37067

37068

The configurator is the function that is being called, when the author

37069

supplies the resolver specific parameters.

37070

37071

37072

<dt> Syntax:</dt>

37073

<dd>context = res.resolvername(subresolver,...)

37074

37075

37076

<dt> subresolver</dt>

37077

<dd>Resolver to which unresolved requests should be forwarded. May be ‘<samp>ti</samp>’

37078

as the final resolver of the resolver chain.

37079

</dd>

37080

</dl>

37081

37082

</dd>

37083

<dt> Details:</dt>

37084

<dd>This function has just one mandatory parameter, the subresolver. You are free

37085

to specify arbitrary further parameters due to the needs of the resolvers task.

37086

37087

All official resolvers will be registered in the registry table ‘<samp>res</samp>’ under

37088

their official name:

37089

37090

<table><tr><td> </td><td><pre class="example">function res.composer(subresolver)

37091

...

37092

end

37093

</pre></td></tr></table>

37094

37095

This configurator function will be called just once per level start. It is

37096

called after the tile declarations and before the first tile is set and the

37097

implementation part may be called.

37098

37099

It is the task of the configurator function to check the user supplied

37100

parameters thoroughly and to provide appropriate error messages on bad

37101

parameters. Do this with a lua error message call at level 2 or the useful

37102

helper functions <a href="#assert_005fbool">assert_bool</a> and <a href="#assert_005ftype">assert_type</a>:

37103

<table><tr><td> </td><td><pre class="example">error("Resolver autotile rule " .. i.." is not a table", 2)

37104

assert_bool(is_resolver(subresolver), "res.composer first argument (subresolver)", 2)

37105

assert_type(args[1], "res.composer second argument (sequence)", 2, "non-empty string")

37106

</pre></td></tr></table>

37107

37108

The configuration function has to return a table that contains the context

37109

for subsequent calls of the implementation. This table has three predefined

37110

entries:

37111

37112

37113

<dt> [1] = implementation function</dt>

37114

<dt> [2] = finalizer function</dt>

37115

<dt> [3] = subresolver</dt>

37116

<dt> ... = resolver specific additional entries</dt>

37117

</dl>

37118

37119

All the checked and preprocessed parameters have to be stored in this context

37120

table for later usage. The resolver implementation function is usually

37121

registered as ‘<samp>res.resolvername_implementation</samp>’. The finalizer can be

37122

‘<samp>nil</samp>’ if no finalization is necessary. The subresolver given as the

37123

first parameter of the configurator call needs to be the third context

37124

table entry.

37125

37126

The context needs to add a metatable with two entries. First <code>"_type"</code>

37127

needs to identify the context as an enigma data type for the <a href="#etype">etype</a>

37128

function. Most resolvers to simply store the string <code>"resolver"</code>, but

37129

special ones might return special identification strings like <code>"maze"</code>.

37130

The second required entry is <code>"_resolver"</code> that needs a boolean ‘<samp>true</samp>’

37131

value assigned for purpose of secure identification of resolver tables. A

37132

default resolver metatable is stored at ‘<samp>res.metatable</samp>’ and can directly

37133

be set by ‘<samp>setmetatable</samp>’.

37134

37135

</dd>

37136

<dt> Full Example:</dt>

37137

<dd><table><tr><td> </td><td><pre class="example">function res.composer(subresolver)

37138

assert_bool(is_resolver(subresolver), "res.composer first argument (subresolver)", 2)

37139

local context = {res.composer_implementation, nil, subresolver}

37140

setmetatable(context, res.metatable)

37141

return context

37142

end

37143

</pre></td></tr></table>

37144

</dd>

37145

</dl>

37146

37147

37148

37149

37150

37151

37152

37153

37154

37155

37156

37157

37158

37159

37160

37161

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

37162

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

37163

37164

</tr></table>

37165

37166

<h3 class="subsection">14.1.2 Resolver Implementation</h3>

37167

37168

37169

When the map gets evaluated on the world creation the top resolver is asked

37170

for every key to return the valid tile declaration. This is done with the

37171

following call.

37172

37173

37174

<dt> Syntax:</dt>

37175

<dd>tile = resolver_implementation(context, evaluator, key, x, y)

37176

37177

37178

<dt> context</dt>

37179

<dd>The context as provided as return value by the <a href="#Resolver-Configurator">Resolver Configurator</a>.

37180

</dd>

37181

<dt> evaluator</dt>

37182

<dd>A system function that needs to be called whenever this resolver needs to

37183

look up the key by its subresolver.

37184

</dd>

37185

37186

<dd>The key string that should be resolved

37187

</dd>

37188

37189

<dd>The position of the tile.

37190

</dd>

37191

</dl>

37192

37193

</dd>

37194

<dt> Details:</dt>

37195

<dd>Based on the given parameters, the key, the position, the resolver parameters

37196

stored in the context and the existing tiles that can be requested via the

37197

evaluator function the implementation needs to decide if it takes influence on

37198

the key. Note that it is not possible to access any world object via its

37199

coordinate at this time. On every call you have to assume that it may be the

37200

first tile that is set.

37201

37202

If the key is not resolved to a final tile by this resolver, the subresolver

37203

must be called via the evaluator function:

37204

<table><tr><td> </td><td><pre class="example">local tile = evaluator(context[3], key, x, y)

37205

</pre></td></tr></table>

37206

37207

Remember that the subresolver is stored at position 3 of the context. As no

37208

influence should be taken this tile is the one that should be returned.

37209

37210

But if you want to return another tile you are free to do it. You can decide

37211

on another key and ask the subresolver for the appropriate tile. You can

37212

even concatenate two tiles returned by subsequent subresolver calls. You are

37213

allowed to return a new tile with a table declaration of an object. Some valid

37214

return statements:

37215

<table><tr><td> </td><td><pre class="example">return evaluator(context[3], "a", x, y)

37216

return evaluator(context[3], "a", x, y) .. evaluator(context[3], "b", x, y)

37217

return evaluator(context[3], "a", x, y) .. ti({"st_laser_n", state=ON})

37218

</pre></td></tr></table>

37219

37220

You are even allowed to add new tile declarations to the tiles repository to

37221

speed up subsequent calls:

37222

<table><tr><td> </td><td><pre class="example">ti["newkey"] = evaluator(context[3], "a", x, y) .. ti({"st_laser_n", state=ON})

37223

</pre></td></tr></table>

37224

37225

A resolver implementation can store and modify any of its private parameters

37226

in the context table for subsequent calls. Especially it can enlist all

37227

coordinates for postprocessing operations in the finalizer.

37228

37229

</dd>

37230

<dt> Full Example:</dt>

37231

<dd>The implementation of the composer (without the special sequence treatment)

37232

<table><tr><td> </td><td><pre class="example">function res.composer_implementation(context, evaluator, key, x, y)

37233

local tile = evaluator(context[3], key, x, y)

37234

if tile ~= nil then

37235

return tile

37236

end

37237

-- try to compose tile

37238

for i = 1, #key do

37239

local subkey = string.rep(" ", i-1) .. string.sub(key, i, i) .. string.rep(" ", #key - i)

37240

local subtile = evaluator(context[3], subkey, x, y)

37241

if subtile == nil then

37242

return nil

37243

end

37244

if tile == nil then

37245

tile = subtile

37246

else

37247

tile = tile .. subtile

37248

end

37249

end

37250

return tile

37251

end

37252

</pre></td></tr></table>

37253

</dd>

37254

</dl>

37255

37256

37257

37258

37259

37260

37261

37262

37263

37264

37265

37266

37267

37268

37269

37270

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

37271

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

37272

37273

</tr></table>

37274

37275

<h3 class="subsection">14.1.3 Resolver Finalizer</h3>

37276

37277

37278

If the <a href="#Resolver-Configurator">Resolver Configurator</a> provides a finalizer function in its context

37279

this function will be called once when all tiles from the map have been set.

37280

37281

37282

<dt> Syntax:</dt>

37283

<dd>resolver_finalization(context)

37284

37285

37286

<dt> context</dt>

37287

<dd>The context as provided as return value by the <a href="#Resolver-Configurator">Resolver Configurator</a>.

37288

</dd>

37289

</dl>

37290

37291

</dd>

37292

<dt> Details:</dt>

37293

<dd>The finalization functions of chained resolvers are called from bottom to top.

37294

37295

Many resolvers have no need of a finalization. But some like a maze constructor

37296

need to know all participating tiles until they can do their final work.

37297

37298

As all tiles from the map have been processed the objects can now be accessed.

37299

Further information may be stored in the resolvers context.

37300

37301

The finalizer does neither call its subresolver nor does it return a value.

37302

</dd>

37303

</dl>

37304

37305

37306

37307

37308

37309

37310

37311

37312

37313

37314

37315

37316

37317

37318

37319

37320

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

37321

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

37322

37323

</tr></table>

37324

37325

<h1 class="chapter">15. Guidelines and Hints</h1>

37326

37327

Up to now we described all features in their full extend. Of course you are

37328

free to use them all without any restrictions for your private levels. We are

37329

committed to maintain all features in future versions of Enigma.

37330

37331

But for inclusion of your levels into the Enigma project we would like to

37332

recommend conformance to some common standards. These few points guarantee that

37333

your levels can easily be processed by our administration tools, the players

37334

can talk about your level and your level remains editable by the project

37335

maintainers in case of urgent need.

37336

37337

Additionally we like to give you some hints how to write good levels by means

37338

of proper strategy.

37339

37340

37341

<tr><td align="left" valign="top"><a href="#Filename-Recommendation">15.1 Filename Recommendation</a></td><td>  </td><td align="left" valign="top">

37342

</td></tr>

37343

<tr><td align="left" valign="top"><a href="#Title-Recommendation">15.2 Title Recommendation</a></td><td>  </td><td align="left" valign="top">

37344

</td></tr>

37345

<tr><td align="left" valign="top"><a href="#Tile-Key-Recommendation">15.3 Tile Key Recommendation</a></td><td>  </td><td align="left" valign="top">

37346

</td></tr>

37347

<tr><td align="left" valign="top"><a href="#Easy-Mode-Hints">15.4 Easy Mode Hints</a></td><td>  </td><td align="left" valign="top">

37348

</td></tr>

37349

</table>

37350

37351

37352

37353

37354

37355

37356

37357

37358

37359

37360

37361

37362

37363

37364

37365

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

37366

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

37367

37368

</tr></table>

37369

37370

<h2 class="section">15.1 Filename Recommendation</h2>

37371

No space for spaces

37372

37373

37374

37375

37376

37377

37378

37379

37380

37381

37382

37383

37384

37385

37386

37387

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

37388

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

37389

37390

</tr></table>

37391

37392

<h2 class="section">15.2 Title Recommendation</h2>

37393

English titles preferred - use subtitle, too

37394

37395

37396

37397

37398

37399

37400

37401

37402

37403

37404

37405

37406

37407

37408

37409

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

37410

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

37411

37412

</tr></table>

37413

37414

<h2 class="section">15.3 Tile Key Recommendation</h2>

37415

37416

The following guidelines are not compulsory, but we nevertheless encourage

37417

them, as they ease the development of new and the maintenance of old levels.

37418

37419

<ul>

37420

<li> Stones use capital letters, items small letters, floors use punctuation marks.

37421

</li><li> The default floor is <code>" "</code>. The second most important floor typically is

37422

<code>"_"</code> or <code>"."</code>. It’s a good idea to use tile keys for floors, which are

37423

small and don’t obstruct the view on the more important objects, like

37424

stones and items. Important floors (like bridges) may have letters or

37425

numbers to emphasize their importance (a bridge could be <code>"b"</code>, or a

37426

number to use autotiling).

37427

</li><li> Water typically is <code>"~"</code>, as the tilde is a small character which resembles

37428

a wave. Similarly, an abyss can be well described by <code>"_"</code>, as the underscore

37429

resembles a hole.

37430

</li><li> On a German keyboard, the four characters <code>"."</code>, <code>","</code>, <code>":"</code> and <code>";"</code> are

37431

arranged in a square, so you can easily use them to arrange quadruples

37432

of floors, like lawn pieces of different brightness.

37433

On a US keyboard, you can use <code>","</code>, <code>"."</code>, <code>"<"</code> and <code>">"</code> to the same purpose.

37434

Another quadruple of characters are the arithmetic operators <code>"+"</code>, <code>"-"</code>,<code>"*"</code>, and <code>"/"</code>.

37435

</li><li> Slopes can be described using <code>"<"</code>, <code>">"</code>, <code>"v"</code> and <code>"^"</code>. As you see, we

37436

encourage you to use the letter <code>"v"</code> for a floor at this point, as it

37437

resembles an arrow pointing down. For slant slopes, it’s a good idea to

37438

use either numbers (following the number keypad on your keyboard), or

37439

quadruple characters like <code>"."</code>, <code>","</code>, <code>":"</code>, <code>";"</code> or arithmetic operators.

37440

</li><li> Although it fits nicely to <code>"/"</code>, it’s not a good idea to use the backslash

37441

as a tile key, as it has to be masked to work correctly. Similarly, we

37442

disencourage the use of brackets as tile keys.

37443

</li><li> The most important simple stone should be <code>"#"</code>, all other stones should

37444

use their first letter, like “laser” -> <code>"L"</code>, “switch” -> <code>"S"</code>, “box” -> <code>"B"</code>.

37445

If two stones have the same first letter, the more important one should

37446

be given priority (<code>"L"</code> for laser instead of <code>"L"</code> for <code>"st_lightglass"</code>,

37447

<code>"G"</code> for <code>"st_lightglass"</code> instead of <code>"G"</code> for <code>"st_greenbrown"</code>).

37448

</li><li> Orientable stones like boulders or lasers should use <code>"N"</code>, <code>"E"</code>, <code>"S"</code>, <code>"W"</code>

37449

if they appear in more than one orientation.

37450

</li><li> Stones of the same kind, which appear several times in different ways

37451

(like switches with different actions) should use consecutive letter

37452

(<code>"S"</code>, <code>"T"</code>, <code>"U"</code>, ...) or numbers.

37453

</li><li> Oxyd stones should use <code>"O"</code> or <code>"0"</code>. If you put several different oxyd

37454

stones, e.g. of different colors, make use of consecutive letters (<code>"P"</code>,

37455

<code>"Q"</code>, <code>"R"</code> ...) or numbers.

37456

</li><li> If you want to put mirrors, it’s a good idea to use characters resembling

37457

the orientation of the mirror, i.e. <code>"|"</code>, <code>"-"</code>, and <code>"/"</code>. As the backslash

37458

is no good tile key, you may use <code>"&"</code> or <code>"Q"</code> instead, as these characters

37459

include a prominent slant line similar to the backslash. Triangular

37460

mirrors are best written with <code>"<"</code>, <code>">"</code>, <code>"v"</code> and <code>"^"</code>.

37461

</li><li> For rotator stones, it’s a good idea to use <code>"R"</code> and <code>"L"</code> for clockwise

37462

(right) and counter-clockwise (left) rotating stones. As an alternative,

37463

you might want to use characters which are written in either clockwise

37464

or counter-clockwise manner, like <code>"p"</code> and <code>"q"</code>. Note that this might

37465

depend on your handwriting.

37466

</li><li> Documents can use either <code>"d"</code>, or <code>"i"</code> (for <code>"information"</code>), as <code>"d"</code> is

37467

used more often (e.g. for autotiling purposes). If several documents

37468

appear in the level, you can use consecutive letters (<code>"i"</code>, <code>"j"</code>, <code>"k"</code> ...).

37469

Remember that you can take advantage of autotiling if you have lots of

37470

different documents in your level.

37471

</li><li> Coins can be written with <code>"c"</code>, with <code>"$"</code> or with numbers resembling their worth.

37472

</li><li> Marbles should be <code>"@"</code>, all other actors should use small letters

37473

(<code>"t"</code> for ac_top, <code>"p"</code> for ac_pearl, ...), or large punctuation marks.

37474

</li><li> For autotiling, it’s a good idea to use <code>"X"</code>, <code>"Y"</code>, <code>"x"</code>, <code>"y"</code>, <code>"*"</code>, <code>"?"</code> and

37475

similar characters which associate themselves with variables as template

37476

keys. Another possibility is to use a full word like <code>"door"</code> or <code>"switch"</code>

37477

as template tile key, which has the advantage of being easier

37478

</li></ul>

37479

37480

37481

37482

37483

37484

37485

37486

37487

37488

37489

37490

37491

37492

37493

37494

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

37495

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

37496

37497

</tr></table>

37498

37499

<h2 class="section">15.4 Easy Mode Hints</h2>

37500

write easy first, floor friction,...

37501

37502

37503

37504

37505

37506

37507

37508

37509

37510

37511

37512

37513

37514

37515

37516

37517

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

37518

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

37519

37520

</tr></table>

37521

37522

<h1 class="chapter">16. Compatibility</h1>

37523

37524

37525

37526

<tr><td align="left" valign="top"><a href="#Engine-Compatibility">16.1 Engine Compatibility</a></td><td>  </td><td align="left" valign="top"> Differences between Compatibility Modes

37527

</td></tr>

37528

</table>

37529

37530

37531

37532

37533

37534

37535

37536

37537

37538

37539

37540

37541

37542

37543

37544

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

37545

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

37546

37547

</tr></table>

37548

37549

<h2 class="section">16.1 Engine Compatibility</h2>

37550

37551

Although Enigma was inspired by the Oxyd game series, there are

37552

some differences between the native Enigma engine mode and the other modes as

37553

well as between the other modes themselves. Using the compatibility element

37554

of the xml-metadata (see section <a href="#g_t_003ccompatibility_003e"><compatibility></a>), it is possible to activate some

37555

of these special features. Here is a list of the major differences

37556

37557

All non-Enigma modes <code>(oxyd1, per.oxyd, oxyd.magnum, oxyd.extra)</code>

37558

37559

<ul>

37560

<li> Keep <a href="#it_005fkey">it_key</a> when using <a href="#st_005fkey">st_key</a>.

37561

</li><li> Oxyd stones (<a href="#st_005foxyd">st_oxyd</a>) must blink before they can be

37562

ultimately opened (pairs must be hit with some time delay).

37563

</li><li> The non-Enigma modes feature a model of the 0.92-Fire System

37564

(see <a href="#Fire-Spreading">Fire Spreading</a>).

37565

</li><li> <a href="#it_005fsquashed">it_squashed</a> and <a href="#it_005fcross">it_cross</a> can’t be removed with

37566

<a href="#it_005fbrush">it_brush</a>.

37567

</li><li> The only function of <a href="#it_005fpencil">it_pencil</a> is to turn

37568

<a href="#st_005fflat">st_flat</a> and its movable variant into the burnable variants.

37569

</li><li> <a href="#it_005fbottle">it_bottle</a> doesn’t break when a stone is pushed over it.

37570

</li><li> <a href="#st_005fswap">st_swap</a> and <a href="#st_005fpull">st_pull</a> may not swap/pull into the level

37571

border.

37572

</li></ul>

37573

37574

37575

<code>oxyd1</code>-compatibility

37576

37577

<ul>

37578

<li> <a href="#it_005fseed">it_seed</a> grows to <a href="#fl_005fwood">fl_wood</a>_framed under <a href="#st_005fgrate">st_grate</a>_cross,

37579

not to <a href="#st_005fbox">st_box</a>_wood.

37580

</li><li> Flying actors may pass <a href="#st_005fgrate">st_grate</a>).

37581

</li><li> <a href="#st_005fbox">st_box</a>_wood only falls when moved.

37582

</li><li> The <code>ignite</code>-message (e.g. by <a href="#it_005fdynamite">it_dynamite</a>) doesn’t

37583

kill <a href="#it_005fdocument">it_document</a>.

37584

</li><li> Bombs <a href="#it_005fbomb">it_bomb</a> aren’t ignited when <a href="#st_005fbox">st_box</a>_wood is pushed over

37585

them (see <code>oxydmagnum</code>-compatibility).

37586

</li></ul>

37587

37588

37589

<code>per.oxyd</code>-compatibility

37590

37591

<ul>

37592

<li> When painted with <a href="#it_005fbrush">it_brush</a>, <a href="#st_005fghost">st_ghost</a>_purplemarble becomes

37593

an open <a href="#st_005ffake">st_fake</a>_oxydc instead of <code>st_purplemarble</code>.

37594

</li><li> <a href="#it_005fhammer">it_hammer</a> doesn’t laser-transform into <a href="#it_005fsword">it_sword</a>.

37595

</li><li> <a href="#it_005fumbrella">it_umbrella</a> doesn’t explode in laser light.

37596

</li><li> <a href="#it_005fcross">it_cross</a> inverts signals it receives.

37597

</li></ul>

37598

37599

37600

<code>oxyd.magnum</code>-compatibility

37601

37602

<ul>

37603

<li> <a href="#it_005fseed">it_seed</a> grows to <a href="#fl_005fwood">fl_wood</a>_framed under <a href="#st_005fgrate">st_grate</a>_cross,

37604

not to <a href="#st_005fbox">st_box</a>_wood.

37605

</li><li> Bombs<a href="#it_005fbomb">it_bomb</a> aren’t ignited when <a href="#st_005fbox">st_box</a>_wood is pushed over

37606

them (see <code>oxyd1</code>-compatibility).

37607

</li></ul>

37608

37609

37610

37611

37612

37613

37614

37615

37616

37617

37618

37619

37620

37621

37622

37623

37624

37625

37626

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

37627

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

37628

37629

</tr></table>

37630

37631

<h1 class="unnumbered">Object Index</h1>

37632

37633

37634

37635

37636

37637

37638

37639

37640

37641

37642

37643

37644

37645

</td></tr></table>

37646

37647

<tr><td></td><th align="left">Index Entry</th><th align="left"> Section</th></tr>

37648

37649

37650

37651

<tr><td></td><td valign="top"><a href="#index-ac_005fhorse">ac_horse</a></td><td valign="top"><a href="#ac_005fhorse">10.2.2 ac_horse</a></td></tr>

37652

<tr><td></td><td valign="top"><a href="#index-ac_005fkiller">ac_killer</a></td><td valign="top"><a href="#ac_005fkiller">10.2.3 ac_killer</a></td></tr>

37653

<tr><td></td><td valign="top"><a href="#index-ac_005fmarble">ac_marble</a></td><td valign="top"><a href="#ac_005fmarble">10.2.4 ac_marble</a></td></tr>

37654

<tr><td></td><td valign="top"><a href="#index-ac_005fpearl">ac_pearl</a></td><td valign="top"><a href="#ac_005fpearl">10.2.5 ac_pearl</a></td></tr>

37655

<tr><td></td><td valign="top"><a href="#index-ac_005frotor">ac_rotor</a></td><td valign="top"><a href="#ac_005frotor">10.2.6 ac_rotor</a></td></tr>

37656

37657

37658

37659

<tr><td></td><td valign="top"><a href="#index-fl_005fabyss">fl_abyss</a></td><td valign="top"><a href="#fl_005fabyss">7.4.1 fl_abyss</a></td></tr>

37660

<tr><td></td><td valign="top"><a href="#index-fl_005fadhesionless">fl_adhesionless</a></td><td valign="top"><a href="#fl_005fadhesionless">7.3.1 fl_adhesionless</a></td></tr>

37661

<tr><td></td><td valign="top"><a href="#index-fl_005faquamarine">fl_aquamarine</a></td><td valign="top"><a href="#fl_005faquamarine">7.3.2 fl_aquamarine</a></td></tr>

37662

37663

<tr><td></td><td valign="top"><a href="#index-fl_005fbluegray">fl_bluegray</a></td><td valign="top"><a href="#fl_005fbluegray">7.3.4 fl_bluegray</a></td></tr>

37664

<tr><td></td><td valign="top"><a href="#index-fl_005fbluegreen">fl_bluegreen</a></td><td valign="top"><a href="#fl_005fbluegreen">7.3.5 fl_bluegreen</a></td></tr>

37665

<tr><td></td><td valign="top"><a href="#index-fl_005fblueslab">fl_blueslab</a></td><td valign="top"><a href="#fl_005fblueslab">7.3.6 fl_blueslab</a></td></tr>

37666

<tr><td></td><td valign="top"><a href="#index-fl_005fbrick">fl_brick</a></td><td valign="top"><a href="#fl_005fbrick">7.3.7 fl_brick</a></td></tr>

37667

<tr><td></td><td valign="top"><a href="#index-fl_005fbridge">fl_bridge</a></td><td valign="top"><a href="#fl_005fbridge">7.4.2 fl_bridge</a></td></tr>

37668

<tr><td></td><td valign="top"><a href="#index-fl_005fbright">fl_bright</a></td><td valign="top"><a href="#fl_005fbright">7.3.8 fl_bright</a></td></tr>

37669

<tr><td></td><td valign="top"><a href="#index-fl_005fconcrete">fl_concrete</a></td><td valign="top"><a href="#fl_005fconcrete">7.3.9 fl_concrete</a></td></tr>

37670

37671

<tr><td></td><td valign="top"><a href="#index-fl_005fdarkgray">fl_darkgray</a></td><td valign="top"><a href="#fl_005fdarkgray">7.3.11 fl_darkgray</a></td></tr>

37672

<tr><td></td><td valign="top"><a href="#index-fl_005fdunes">fl_dunes</a></td><td valign="top"><a href="#fl_005fdunes">7.3.12 fl_dunes</a></td></tr>

37673

37674

<tr><td></td><td valign="top"><a href="#index-fl_005fgravel">fl_gravel</a></td><td valign="top"><a href="#fl_005fgravel">7.3.13 fl_gravel</a></td></tr>

37675

37676

37677

<tr><td></td><td valign="top"><a href="#index-fl_005fhimalaya">fl_himalaya</a></td><td valign="top"><a href="#fl_005fhimalaya">7.3.15 fl_himalaya</a></td></tr>

37678

37679

<tr><td></td><td valign="top"><a href="#index-fl_005finverse">fl_inverse</a></td><td valign="top"><a href="#fl_005finverse">7.4.6 fl_inverse</a></td></tr>

37680

<tr><td></td><td valign="top"><a href="#index-fl_005fivory">fl_ivory</a></td><td valign="top"><a href="#fl_005fivory">7.3.16 fl_ivory</a></td></tr>

37681

37682

<tr><td></td><td valign="top"><a href="#index-fl_005fmarble">fl_marble</a></td><td valign="top"><a href="#fl_005fmarble">7.3.18 fl_marble</a></td></tr>

37683

<tr><td></td><td valign="top"><a href="#index-fl_005fmetal">fl_metal</a></td><td valign="top"><a href="#fl_005fmetal">7.3.19 fl_metal</a></td></tr>

37684

<tr><td></td><td valign="top"><a href="#index-fl_005fmortar">fl_mortar</a></td><td valign="top"><a href="#fl_005fmortar">7.3.20 fl_mortar</a></td></tr>

37685

<tr><td></td><td valign="top"><a href="#index-fl_005fnil">fl_nil</a></td><td valign="top"><a href="#Tile-and-Object-Declaration">5.11 Tile and Object Declaration</a></td></tr>

37686

<tr><td></td><td valign="top"><a href="#index-fl_005fpinkbumps">fl_pinkbumps</a></td><td valign="top"><a href="#fl_005fpinkbumps">7.3.21 fl_pinkbumps</a></td></tr>

37687

<tr><td></td><td valign="top"><a href="#index-fl_005fplank">fl_plank</a></td><td valign="top"><a href="#fl_005fplank">7.3.22 fl_plank</a></td></tr>

37688

<tr><td></td><td valign="top"><a href="#index-fl_005fplatinum">fl_platinum</a></td><td valign="top"><a href="#fl_005fplatinum">7.3.23 fl_platinum</a></td></tr>

37689

37690

<tr><td></td><td valign="top"><a href="#index-fl_005fredslab">fl_redslab</a></td><td valign="top"><a href="#fl_005fredslab">7.3.25 fl_redslab</a></td></tr>

37691

37692

<tr><td></td><td valign="top"><a href="#index-fl_005frough">fl_rough</a></td><td valign="top"><a href="#fl_005frough">7.3.26 fl_rough</a></td></tr>

37693

<tr><td></td><td valign="top"><a href="#index-fl_005fsahara">fl_sahara</a></td><td valign="top"><a href="#fl_005fsahara">7.3.27 fl_sahara</a></td></tr>

37694

<tr><td></td><td valign="top"><a href="#index-fl_005fsamba">fl_samba</a></td><td valign="top"><a href="#fl_005fsamba">7.3.28 fl_samba</a></td></tr>

37695

37696

<tr><td></td><td valign="top"><a href="#index-fl_005fscales">fl_scales</a></td><td valign="top"><a href="#fl_005fscales">7.4.8 fl_scales</a></td></tr>

37697

<tr><td></td><td valign="top"><a href="#index-fl_005fslope">fl_slope</a></td><td valign="top"><a href="#fl_005fslope">7.4.9 fl_slope</a></td></tr>

37698

<tr><td></td><td valign="top"><a href="#index-fl_005fspace">fl_space</a></td><td valign="top"><a href="#fl_005fspace">7.3.30 fl_space</a></td></tr>

37699

<tr><td></td><td valign="top"><a href="#index-fl_005fstone">fl_stone</a></td><td valign="top"><a href="#fl_005fstone">7.3.31 fl_stone</a></td></tr>

37700

<tr><td></td><td valign="top"><a href="#index-fl_005fswamp">fl_swamp</a></td><td valign="top"><a href="#fl_005fswamp">7.4.10 fl_swamp</a></td></tr>

37701

<tr><td></td><td valign="top"><a href="#index-fl_005fthief">fl_thief</a></td><td valign="top"><a href="#fl_005fthief">7.4.11 fl_thief</a></td></tr>

37702

<tr><td></td><td valign="top"><a href="#index-fl_005ftigris">fl_tigris</a></td><td valign="top"><a href="#fl_005ftigris">7.3.32 fl_tigris</a></td></tr>

37703

<tr><td></td><td valign="top"><a href="#index-fl_005fwater">fl_water</a></td><td valign="top"><a href="#fl_005fwater">7.4.12 fl_water</a></td></tr>

37704

<tr><td></td><td valign="top"><a href="#index-fl_005fwhite">fl_white</a></td><td valign="top"><a href="#fl_005fwhite">7.3.33 fl_white</a></td></tr>

37705

37706

<tr><td></td><td valign="top"><a href="#index-fl_005fwoven">fl_woven</a></td><td valign="top"><a href="#fl_005fwoven">7.3.34 fl_woven</a></td></tr>

37707

<tr><td></td><td valign="top"><a href="#index-fl_005fyinyang">fl_yinyang</a></td><td valign="top"><a href="#fl_005fyinyang">7.4.14 fl_yinyang</a></td></tr>

37708

37709

37710

37711

<tr><td></td><td valign="top"><a href="#index-it_005fbanana">it_banana</a></td><td valign="top"><a href="#it_005fbanana">8.3.2 it_banana</a></td></tr>

37712

<tr><td></td><td valign="top"><a href="#index-it_005fblocker">it_blocker</a></td><td valign="top"><a href="#it_005fblocker">8.4.1 it_blocker</a></td></tr>

37713

37714

<tr><td></td><td valign="top"><a href="#index-it_005fbottle">it_bottle</a></td><td valign="top"><a href="#it_005fbottle">8.3.3 it_bottle</a></td></tr>

37715

<tr><td></td><td valign="top"><a href="#index-it_005fbrake">it_brake</a></td><td valign="top"><a href="#it_005fbrake">8.3.4 it_brake</a></td></tr>

37716

<tr><td></td><td valign="top"><a href="#index-it_005fbrush">it_brush</a></td><td valign="top"><a href="#it_005fbrush">8.3.5 it_brush</a></td></tr>

37717

<tr><td></td><td valign="top"><a href="#index-it_005fburnable">it_burnable</a></td><td valign="top"><a href="#it_005fburnable">8.4.3 it_burnable</a></td></tr>

37718

<tr><td></td><td valign="top"><a href="#index-it_005fcherry">it_cherry</a></td><td valign="top"><a href="#it_005fcherry">8.3.6 it_cherry</a></td></tr>

37719

<tr><td></td><td valign="top"><a href="#index-it_005fcoffee">it_coffee</a></td><td valign="top"><a href="#it_005fcoffee">8.3.7 it_coffee</a></td></tr>

37720

37721

<tr><td></td><td valign="top"><a href="#index-it_005fcrack">it_crack</a></td><td valign="top"><a href="#it_005fcrack">8.4.4 it_crack</a></td></tr>

37722

<tr><td></td><td valign="top"><a href="#index-it_005fcross">it_cross</a></td><td valign="top"><a href="#it_005fcross">8.4.5 it_cross</a></td></tr>

37723

<tr><td></td><td valign="top"><a href="#index-it_005fdeath">it_death</a></td><td valign="top"><a href="#it_005fdeath">8.4.6 it_death</a></td></tr>

37724

<tr><td></td><td valign="top"><a href="#index-it_005fdocument">it_document</a></td><td valign="top"><a href="#it_005fdocument">8.3.9 it_document</a></td></tr>

37725

37726

<tr><td></td><td valign="top"><a href="#index-it_005fdynamite">it_dynamite</a></td><td valign="top"><a href="#it_005fdynamite">8.3.11 it_dynamite</a></td></tr>

37727

<tr><td></td><td valign="top"><a href="#index-it_005fexplosion">it_explosion</a></td><td valign="top"><a href="#it_005fexplosion">8.4.7 it_explosion</a></td></tr>

37728

<tr><td></td><td valign="top"><a href="#index-it_005fextinguisher">it_extinguisher</a></td><td valign="top"><a href="#it_005fextinguisher">8.3.12 it_extinguisher</a></td></tr>

37729

<tr><td></td><td valign="top"><a href="#index-it_005fextralife">it_extralife</a></td><td valign="top"><a href="#it_005fextralife">8.3.13 it_extralife</a></td></tr>

37730

37731

<tr><td></td><td valign="top"><a href="#index-it_005ffloppy">it_floppy</a></td><td valign="top"><a href="#it_005ffloppy">8.3.15 it_floppy</a></td></tr>

37732

<tr><td></td><td valign="top"><a href="#index-it_005fglasses">it_glasses</a></td><td valign="top"><a href="#it_005fglasses">8.3.16 it_glasses</a></td></tr>

37733

<tr><td></td><td valign="top"><a href="#index-it_005fhammer">it_hammer</a></td><td valign="top"><a href="#it_005fhammer">8.3.17 it_hammer</a></td></tr>

37734

37735

<tr><td></td><td valign="top"><a href="#index-it_005flandmine">it_landmine</a></td><td valign="top"><a href="#it_005flandmine">8.4.8 it_landmine</a></td></tr>

37736

<tr><td></td><td valign="top"><a href="#index-it_005flaserbeam">it_laserbeam</a></td><td valign="top"><a href="#it_005flaserbeam">8.4.9 it_laserbeam</a></td></tr>

37737

<tr><td></td><td valign="top"><a href="#index-it_005fmagicwand">it_magicwand</a></td><td valign="top"><a href="#it_005fmagicwand">8.3.19 it_magicwand</a></td></tr>

37738

<tr><td></td><td valign="top"><a href="#index-it_005fmagnet">it_magnet</a></td><td valign="top"><a href="#it_005fmagnet">8.4.10 it_magnet</a></td></tr>

37739

<tr><td></td><td valign="top"><a href="#index-it_005fmeditation">it_meditation</a></td><td valign="top"><a href="#it_005fmeditation">8.4.11 it_meditation</a></td></tr>

37740

<tr><td></td><td valign="top"><a href="#index-it_005fnil">it_nil</a></td><td valign="top"><a href="#Tile-and-Object-Declaration">5.11 Tile and Object Declaration</a></td></tr>

37741

<tr><td></td><td valign="top"><a href="#index-it_005fpencil">it_pencil</a></td><td valign="top"><a href="#it_005fpencil">8.3.20 it_pencil</a></td></tr>

37742

37743

37744

<tr><td></td><td valign="top"><a href="#index-it_005fpuller">it_puller</a></td><td valign="top"><a href="#it_005fpuller">8.3.23 it_puller</a></td></tr>

37745

37746

<tr><td></td><td valign="top"><a href="#index-it_005frubberband">it_rubberband</a></td><td valign="top"><a href="#it_005frubberband">8.3.25 it_rubberband</a></td></tr>

37747

37748

<tr><td></td><td valign="top"><a href="#index-it_005fsensor">it_sensor</a></td><td valign="top"><a href="#it_005fsensor">8.4.12 it_sensor</a></td></tr>

37749

<tr><td></td><td valign="top"><a href="#index-it_005fshogun">it_shogun</a></td><td valign="top"><a href="#it_005fshogun">8.4.13 it_shogun</a></td></tr>

37750

<tr><td></td><td valign="top"><a href="#index-it_005fspade">it_spade</a></td><td valign="top"><a href="#it_005fspade">8.3.27 it_spade</a></td></tr>

37751

<tr><td></td><td valign="top"><a href="#index-it_005fspoon">it_spoon</a></td><td valign="top"><a href="#it_005fspoon">8.3.28 it_spoon</a></td></tr>

37752

<tr><td></td><td valign="top"><a href="#index-it_005fspring">it_spring</a></td><td valign="top"><a href="#it_005fspring">8.3.29 it_spring</a></td></tr>

37753

<tr><td></td><td valign="top"><a href="#index-it_005fspringboard">it_springboard</a></td><td valign="top"><a href="#it_005fspringboard">8.4.14 it_springboard</a></td></tr>

37754

<tr><td></td><td valign="top"><a href="#index-it_005fsquashed">it_squashed</a></td><td valign="top"><a href="#it_005fsquashed">8.4.15 it_squashed</a></td></tr>

37755

<tr><td></td><td valign="top"><a href="#index-it_005fstrip">it_strip</a></td><td valign="top"><a href="#it_005fstrip">8.4.16 it_strip</a></td></tr>

37756

<tr><td></td><td valign="top"><a href="#index-it_005fsurprise">it_surprise</a></td><td valign="top"><a href="#it_005fsurprise">8.3.30 it_surprise</a></td></tr>

37757

<tr><td></td><td valign="top"><a href="#index-it_005fsword">it_sword</a></td><td valign="top"><a href="#it_005fsword">8.3.31 it_sword</a></td></tr>

37758

37759

<tr><td></td><td valign="top"><a href="#index-it_005ftrigger">it_trigger</a></td><td valign="top"><a href="#it_005ftrigger">8.4.18 it_trigger</a></td></tr>

37760

<tr><td></td><td valign="top"><a href="#index-it_005fumbrella">it_umbrella</a></td><td valign="top"><a href="#it_005fumbrella">8.3.32 it_umbrella</a></td></tr>

37761

<tr><td></td><td valign="top"><a href="#index-it_005fvortex">it_vortex</a></td><td valign="top"><a href="#it_005fvortex">8.4.19 it_vortex</a></td></tr>

37762

<tr><td></td><td valign="top"><a href="#index-it_005fweight">it_weight</a></td><td valign="top"><a href="#it_005fweight">8.3.33 it_weight</a></td></tr>

37763

<tr><td></td><td valign="top"><a href="#index-it_005fwormhole">it_wormhole</a></td><td valign="top"><a href="#it_005fwormhole">8.4.20 it_wormhole</a></td></tr>

37764

<tr><td></td><td valign="top"><a href="#index-it_005fwrench">it_wrench</a></td><td valign="top"><a href="#it_005fwrench">8.3.34 it_wrench</a></td></tr>

37765

<tr><td></td><td valign="top"><a href="#index-it_005fyinyang">it_yinyang</a></td><td valign="top"><a href="#it_005fyinyang">8.3.35 it_yinyang</a></td></tr>

37766

37767

37768

<tr><td></td><td valign="top"><a href="#index-nil">nil</a></td><td valign="top"><a href="#Tile-and-Object-Declaration">5.11 Tile and Object Declaration</a></td></tr>

37769

37770

37771

<tr><td></td><td valign="top"><a href="#index-ot_005fcannonball">ot_cannonball</a></td><td valign="top"><a href="#ot_005fcannonball">11.1.1 ot_cannonball</a></td></tr>

37772

<tr><td></td><td valign="top"><a href="#index-ot_005fcounter">ot_counter</a></td><td valign="top"><a href="#ot_005fcounter">11.2.1 ot_counter</a></td></tr>

37773

<tr><td></td><td valign="top"><a href="#index-ot_005frubberband">ot_rubberband</a></td><td valign="top"><a href="#ot_005frubberband">11.1.2 ot_rubberband</a></td></tr>

37774

<tr><td></td><td valign="top"><a href="#index-ot_005ftimer">ot_timer</a></td><td valign="top"><a href="#ot_005ftimer">11.2.2 ot_timer</a></td></tr>

37775

37776

37777

37778

<tr><td></td><td valign="top"><a href="#index-st_005factorimpulse">st_actorimpulse</a></td><td valign="top"><a href="#st_005factorimpulse">9.5.1 st_actorimpulse</a></td></tr>

37779

<tr><td></td><td valign="top"><a href="#index-st_005fancient">st_ancient</a></td><td valign="top"><a href="#st_005fancient">9.3.1 st_ancient</a></td></tr>

37780

<tr><td></td><td valign="top"><a href="#index-st_005fbarrier">st_barrier</a></td><td valign="top"><a href="#st_005fbarrier">9.5.2 st_barrier</a></td></tr>

37781

<tr><td></td><td valign="top"><a href="#index-st_005fbeads">st_beads</a></td><td valign="top"><a href="#st_005fbeads">9.5.3 st_beads</a></td></tr>

37782

<tr><td></td><td valign="top"><a href="#index-st_005fblocker">st_blocker</a></td><td valign="top"><a href="#st_005fblocker">9.5.4 st_blocker</a></td></tr>

37783

<tr><td></td><td valign="top"><a href="#index-st_005fbluegray">st_bluegray</a></td><td valign="top"><a href="#st_005fbluegray">9.3.2 st_bluegray</a></td></tr>

37784

<tr><td></td><td valign="top"><a href="#index-st_005fbluesand">st_bluesand</a></td><td valign="top"><a href="#st_005fbluesand">9.4.2 st_bluesand</a></td></tr>

37785

37786

<tr><td></td><td valign="top"><a href="#index-st_005fboulder">st_boulder</a></td><td valign="top"><a href="#st_005fboulder">9.5.6 st_boulder</a></td></tr>

37787

37788

<tr><td></td><td valign="top"><a href="#index-st_005fbrake">st_brake</a></td><td valign="top"><a href="#st_005fbrake">9.5.8 st_brake</a></td></tr>

37789

<tr><td></td><td valign="top"><a href="#index-st_005fbreak">st_break</a></td><td valign="top"><a href="#st_005fbreak">9.5.9 st_break</a></td></tr>

37790

<tr><td></td><td valign="top"><a href="#index-st_005fbrick">st_brick</a></td><td valign="top"><a href="#st_005fbrick">9.4.3 st_brick</a></td></tr>

37791

<tr><td></td><td valign="top"><a href="#index-st_005fbrownie">st_brownie</a></td><td valign="top"><a href="#st_005fbrownie">9.3.3 st_brownie</a></td></tr>

37792

<tr><td></td><td valign="top"><a href="#index-st_005fbrownmarble">st_brownmarble</a></td><td valign="top"><a href="#st_005fbrownmarble">9.3.4 st_brownmarble</a></td></tr>

37793

<tr><td></td><td valign="top"><a href="#index-st_005fbrownpyramid">st_brownpyramid</a></td><td valign="top"><a href="#st_005fbrownpyramid">9.5.10 st_brownpyramid</a></td></tr>

37794

<tr><td></td><td valign="top"><a href="#index-st_005fcamouflage">st_camouflage</a></td><td valign="top"><a href="#st_005fcamouflage">9.3.5 st_camouflage</a></td></tr>

37795

<tr><td></td><td valign="top"><a href="#index-st_005fchameleon">st_chameleon</a></td><td valign="top"><a href="#st_005fchameleon">9.5.11 st_chameleon</a></td></tr>

37796

<tr><td></td><td valign="top"><a href="#index-st_005fcharge">st_charge</a></td><td valign="top"><a href="#st_005fcharge">9.5.12 st_charge</a></td></tr>

37797

<tr><td></td><td valign="top"><a href="#index-st_005fchess">st_chess</a></td><td valign="top"><a href="#st_005fchess">9.5.13 st_chess</a></td></tr>

37798

<tr><td></td><td valign="top"><a href="#index-st_005fcoinslot">st_coinslot</a></td><td valign="top"><a href="#st_005fcoinslot">9.5.14 st_coinslot</a></td></tr>

37799

<tr><td></td><td valign="top"><a href="#index-st_005fconcrete">st_concrete</a></td><td valign="top"><a href="#st_005fconcrete">9.3.6 st_concrete</a></td></tr>

37800

<tr><td></td><td valign="top"><a href="#index-st_005fdarkglass">st_darkglass</a></td><td valign="top"><a href="#st_005fdarkglass">9.5.15 st_darkglass</a></td></tr>

37801

<tr><td></td><td valign="top"><a href="#index-st_005fdarkgray">st_darkgray</a></td><td valign="top"><a href="#st_005fdarkgray">9.3.7 st_darkgray</a></td></tr>

37802

<tr><td></td><td valign="top"><a href="#index-st_005fdeath">st_death</a></td><td valign="top"><a href="#st_005fdeath">9.5.16 st_death</a></td></tr>

37803

<tr><td></td><td valign="top"><a href="#index-st_005fdisco">st_disco</a></td><td valign="top"><a href="#st_005fdisco">9.5.17 st_disco</a></td></tr>

37804

<tr><td></td><td valign="top"><a href="#index-st_005fdispenser">st_dispenser</a></td><td valign="top"><a href="#st_005fdispenser">9.5.18 st_dispenser</a></td></tr>

37805

37806

37807

<tr><td></td><td valign="top"><a href="#index-st_005fflash">st_flash</a></td><td valign="top"><a href="#st_005fflash">9.5.21 st_flash</a></td></tr>

37808

37809

<tr><td></td><td valign="top"><a href="#index-st_005ffloppy">st_floppy</a></td><td valign="top"><a href="#st_005ffloppy">9.5.23 st_floppy</a></td></tr>

37810

<tr><td></td><td valign="top"><a href="#index-st_005ffourswitch">st_fourswitch</a></td><td valign="top"><a href="#st_005ffourswitch">9.5.24 st_fourswitch</a></td></tr>

37811

<tr><td></td><td valign="top"><a href="#index-st_005fghost">st_ghost</a></td><td valign="top"><a href="#st_005fghost">9.5.25 st_ghost</a></td></tr>

37812

<tr><td></td><td valign="top"><a href="#index-st_005fgranite">st_granite</a></td><td valign="top"><a href="#st_005fgranite">9.3.8 st_granite</a></td></tr>

37813

<tr><td></td><td valign="top"><a href="#index-st_005fgrate">st_grate</a></td><td valign="top"><a href="#st_005fgrate">9.5.26 st_grate</a></td></tr>

37814

<tr><td></td><td valign="top"><a href="#index-st_005fgreenbrown">st_greenbrown</a></td><td valign="top"><a href="#st_005fgreenbrown">9.5.27 st_greenbrown</a></td></tr>

37815

<tr><td></td><td valign="top"><a href="#index-st_005fgreengray">st_greengray</a></td><td valign="top"><a href="#st_005fgreengray">9.3.9 st_greengray</a></td></tr>

37816

37817

<tr><td></td><td valign="top"><a href="#index-st_005finvisible">st_invisible</a></td><td valign="top"><a href="#st_005finvisible">9.3.10 st_invisible</a></td></tr>

37818

37819

37820

<tr><td></td><td valign="top"><a href="#index-st_005fknight">st_knight</a></td><td valign="top"><a href="#st_005fknight">9.5.31 st_knight</a></td></tr>

37821

<tr><td></td><td valign="top"><a href="#index-st_005flaser">st_laser</a></td><td valign="top"><a href="#st_005flaser">9.5.32 st_laser</a></td></tr>

37822

<tr><td></td><td valign="top"><a href="#index-st_005flaserflop">st_laserflop</a></td><td valign="top"><a href="#st_005flaserflop">9.5.33 st_laserflop</a></td></tr>

37823

<tr><td></td><td valign="top"><a href="#index-st_005flaserswitch">st_laserswitch</a></td><td valign="top"><a href="#st_005flaserswitch">9.5.34 st_laserswitch</a></td></tr>

37824

<tr><td></td><td valign="top"><a href="#index-st_005flightglass">st_lightglass</a></td><td valign="top"><a href="#st_005flightglass">9.5.35 st_lightglass</a></td></tr>

37825

<tr><td></td><td valign="top"><a href="#index-st_005flightpassenger">st_lightpassenger</a></td><td valign="top"><a href="#st_005flightpassenger">9.5.36 st_lightpassenger</a></td></tr>

37826

<tr><td></td><td valign="top"><a href="#index-st_005fmagic">st_magic</a></td><td valign="top"><a href="#st_005fmagic">9.5.37 st_magic</a></td></tr>

37827

37828

<tr><td></td><td valign="top"><a href="#index-st_005fmetal">st_metal</a></td><td valign="top"><a href="#st_005fmetal">9.3.11 st_metal</a></td></tr>

37829

<tr><td></td><td valign="top"><a href="#index-st_005fmirror">st_mirror</a></td><td valign="top"><a href="#st_005fmirror">9.5.39 st_mirror</a></td></tr>

37830

<tr><td></td><td valign="top"><a href="#index-st_005fmonoflop">st_monoflop</a></td><td valign="top"><a href="#st_005fmonoflop">9.5.40 st_monoflop</a></td></tr>

37831

<tr><td></td><td valign="top"><a href="#index-st_005fnil">st_nil</a></td><td valign="top"><a href="#Tile-and-Object-Declaration">5.11 Tile and Object Declaration</a></td></tr>

37832

<tr><td></td><td valign="top"><a href="#index-st_005foneway">st_oneway</a></td><td valign="top"><a href="#st_005foneway">9.5.41 st_oneway</a></td></tr>

37833

37834

<tr><td></td><td valign="top"><a href="#index-st_005fpanel">st_panel</a></td><td valign="top"><a href="#st_005fpanel">9.4.4 st_panel</a></td></tr>

37835

<tr><td></td><td valign="top"><a href="#index-st_005fpassage">st_passage</a></td><td valign="top"><a href="#st_005fpassage">9.5.43 st_passage</a></td></tr>

37836

<tr><td></td><td valign="top"><a href="#index-st_005fpinkbumps">st_pinkbumps</a></td><td valign="top"><a href="#st_005fpinkbumps">9.3.12 st_pinkbumps</a></td></tr>

37837

<tr><td></td><td valign="top"><a href="#index-st_005fplaster">st_plaster</a></td><td valign="top"><a href="#st_005fplaster">9.5.44 st_plaster</a></td></tr>

37838

37839

<tr><td></td><td valign="top"><a href="#index-st_005fpolarswitch">st_polarswitch</a></td><td valign="top"><a href="#st_005fpolarswitch">9.5.46 st_polarswitch</a></td></tr>

37840

<tr><td></td><td valign="top"><a href="#index-st_005fportal">st_portal</a></td><td valign="top"><a href="#st_005fportal">9.5.47 st_portal</a></td></tr>

37841

37842

<tr><td></td><td valign="top"><a href="#index-st_005fpurplegray">st_purplegray</a></td><td valign="top"><a href="#st_005fpurplegray">9.3.13 st_purplegray</a></td></tr>

37843

<tr><td></td><td valign="top"><a href="#index-st_005fpurplemarble">st_purplemarble</a></td><td valign="top"><a href="#st_005fpurplemarble">9.3.14 st_purplemarble</a></td></tr>

37844

<tr><td></td><td valign="top"><a href="#index-st_005fpuzzle">st_puzzle</a></td><td valign="top"><a href="#st_005fpuzzle">9.5.49 st_puzzle</a></td></tr>

37845

<tr><td></td><td valign="top"><a href="#index-st_005fquake">st_quake</a></td><td valign="top"><a href="#st_005fquake">9.5.50 st_quake</a></td></tr>

37846

<tr><td></td><td valign="top"><a href="#index-st_005frawglass">st_rawglass</a></td><td valign="top"><a href="#st_005frawglass">9.5.51 st_rawglass</a></td></tr>

37847

<tr><td></td><td valign="top"><a href="#index-st_005fredbrown">st_redbrown</a></td><td valign="top"><a href="#st_005fredbrown">9.3.15 st_redbrown</a></td></tr>

37848

<tr><td></td><td valign="top"><a href="#index-st_005fredfiber">st_redfiber</a></td><td valign="top"><a href="#st_005fredfiber">9.5.52 st_redfiber</a></td></tr>

37849

<tr><td></td><td valign="top"><a href="#index-st_005fredmarble">st_redmarble</a></td><td valign="top"><a href="#st_005fredmarble">9.3.16 st_redmarble</a></td></tr>

37850

<tr><td></td><td valign="top"><a href="#index-st_005fredrock">st_redrock</a></td><td valign="top"><a href="#st_005fredrock">9.3.17 st_redrock</a></td></tr>

37851

<tr><td></td><td valign="top"><a href="#index-st_005frotator">st_rotator</a></td><td valign="top"><a href="#st_005frotator">9.5.53 st_rotator</a></td></tr>

37852

<tr><td></td><td valign="top"><a href="#index-st_005frubberband">st_rubberband</a></td><td valign="top"><a href="#st_005frubberband">9.5.54 st_rubberband</a></td></tr>

37853

<tr><td></td><td valign="top"><a href="#index-st_005fscissors">st_scissors</a></td><td valign="top"><a href="#st_005fscissors">9.5.55 st_scissors</a></td></tr>

37854

<tr><td></td><td valign="top"><a href="#index-st_005fshogun">st_shogun</a></td><td valign="top"><a href="#st_005fshogun">9.5.56 st_shogun</a></td></tr>

37855

<tr><td></td><td valign="top"><a href="#index-st_005fspitter">st_spitter</a></td><td valign="top"><a href="#st_005fspitter">9.5.57 st_spitter</a></td></tr>

37856

<tr><td></td><td valign="top"><a href="#index-st_005fstoneimpulse">st_stoneimpulse</a></td><td valign="top"><a href="#st_005fstoneimpulse">9.5.58 st_stoneimpulse</a></td></tr>

37857

<tr><td></td><td valign="top"><a href="#index-st_005fsurprise">st_surprise</a></td><td valign="top"><a href="#st_005fsurprise">9.5.59 st_surprise</a></td></tr>

37858

37859

<tr><td></td><td valign="top"><a href="#index-st_005fswitch">st_switch</a></td><td valign="top"><a href="#st_005fswitch">9.5.61 st_switch</a></td></tr>

37860

<tr><td></td><td valign="top"><a href="#index-st_005fthief">st_thief</a></td><td valign="top"><a href="#st_005fthief">9.5.62 st_thief</a></td></tr>

37861

<tr><td></td><td valign="top"><a href="#index-st_005ftigris">st_tigris</a></td><td valign="top"><a href="#st_005ftigris">9.3.18 st_tigris</a></td></tr>

37862

<tr><td></td><td valign="top"><a href="#index-st_005ftimer">st_timer</a></td><td valign="top"><a href="#st_005ftimer">9.5.63 st_timer</a></td></tr>

37863

<tr><td></td><td valign="top"><a href="#index-st_005fturnstile">st_turnstile</a></td><td valign="top"><a href="#st_005fturnstile">9.5.64 st_turnstile</a></td></tr>

37864

<tr><td></td><td valign="top"><a href="#index-st_005fturnstilearm">st_turnstilearm</a></td><td valign="top"><a href="#st_005fturnstilearm">9.5.65 st_turnstilearm</a></td></tr>

37865

<tr><td></td><td valign="top"><a href="#index-st_005fvolcano">st_volcano</a></td><td valign="top"><a href="#st_005fvolcano">9.5.66 st_volcano</a></td></tr>

37866

<tr><td></td><td valign="top"><a href="#index-st_005fwindow">st_window</a></td><td valign="top"><a href="#st_005fwindow">9.5.67 st_window</a></td></tr>

37867

<tr><td></td><td valign="top"><a href="#index-st_005fwoven">st_woven</a></td><td valign="top"><a href="#st_005fwoven">9.3.19 st_woven</a></td></tr>

37868

<tr><td></td><td valign="top"><a href="#index-st_005fyellow">st_yellow</a></td><td valign="top"><a href="#st_005fyellow">9.3.20 st_yellow</a></td></tr>

37869

<tr><td></td><td valign="top"><a href="#index-st_005fyinyang">st_yinyang</a></td><td valign="top"><a href="#st_005fyinyang">9.5.68 st_yinyang</a></td></tr>

37870

37871

</table>

37872

37873

37874

37875

37876

37877

37878

37879

37880

37881

37882

37883

37884

</td></tr></table>

37885

37886

37887

37888

37889

37890

37891

37892

37893

37894

37895

37896

37897

37898

37899

37900

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

37901

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

37902

37903

</tr></table>

37904

37905

<h1 class="unnumbered">Attribute Index</h1>

37906

37907

37908

37909

37910

37911

37912

37913

</td></tr></table>

37914

37915

<tr><td></td><th align="left">Index Entry</th><th align="left"> Section</th></tr>

37916

37917

37918

<tr><td></td><td valign="top"><a href="#index-autoclose">autoclose</a></td><td valign="top"><a href="#it_005fblocker">8.4.1 it_blocker</a></td></tr>

37919

<tr><td></td><td valign="top"><a href="#index-autoclose-1">autoclose</a></td><td valign="top"><a href="#st_005fblocker">9.5.4 st_blocker</a></td></tr>

37920

37921

37922

<tr><td></td><td valign="top"><a href="#index-orientation">orientation</a></td><td valign="top"><a href="#it_005fpuller">8.3.23 it_puller</a></td></tr>

37923

<tr><td></td><td valign="top"><a href="#index-orientation-1">orientation</a></td><td valign="top"><a href="#st_005fboulder">9.5.6 st_boulder</a></td></tr>

37924

<tr><td></td><td valign="top"><a href="#index-orientation-2">orientation</a></td><td valign="top"><a href="#st_005fturnstile">9.5.64 st_turnstile</a></td></tr>

37925

<tr><td></td><td valign="top"><a href="#index-orientation-3">orientation</a></td><td valign="top"><a href="#st_005fturnstilearm">9.5.65 st_turnstilearm</a></td></tr>

37926

37927

37928

<tr><td></td><td valign="top"><a href="#index-state">state</a></td><td valign="top"><a href="#st_005ffourswitch">9.5.24 st_fourswitch</a></td></tr>

37929

37930

</table>

37931

37932

37933

37934

37935

37936

37937

</td></tr></table>

37938

37939

37940

37941

37942

37943

37944

37945

37946

37947

37948

37949

37950

37951

37952

37953

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

37954

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

37955

37956

</tr></table>

37957

37958

<h1 class="unnumbered">Message Index</h1>

37959

37960

37961

37962

</td></tr></table>

37963

37964

<tr><td></td><th align="left">Index Entry</th><th align="left"> Section</th></tr>

37965

37966

37967

<tr><td></td><td valign="top"><a href="#index-orientate">orientate</a></td><td valign="top"><a href="#st_005fboulder">9.5.6 st_boulder</a></td></tr>

37968

<tr><td></td><td valign="top"><a href="#index-orientate-1">orientate</a></td><td valign="top"><a href="#st_005fmirror">9.5.39 st_mirror</a></td></tr>

37969

<tr><td></td><td valign="top"><a href="#index-orientate-2">orientate</a></td><td valign="top"><a href="#st_005fturnstilearm">9.5.65 st_turnstilearm</a></td></tr>

37970

37971

</table>

37972

37973

37974

</td></tr></table>

37975

37976

37977

37978

37979

37980

37981

37982

37983

37984

37985

37986

37987

37988

37989

37990

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

37991

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

37992

37993

</tr></table>

37994

37995

<h1 class="unnumbered">Function Index</h1>

37996

37997

37998

37999

38000

38001

38002

38003

38004

38005

38006

38007

38008

38009

38010

38011

38012

38013

38014

38015

38016

38017

38018

38019

38020

</td></tr></table>

38021

38022

<tr><td></td><th align="left">Index Entry</th><th align="left"> Section</th></tr>

38023

38024

38025

<tr><td></td><td valign="top"><a href="#index-assert_005fbool"><code>assert_bool</code></a></td><td valign="top"><a href="#assert_005fbool">5.14.1 assert_bool</a></td></tr>

38026

<tr><td></td><td valign="top"><a href="#index-assert_005ftype"><code>assert_type</code></a></td><td valign="top"><a href="#assert_005ftype">5.14.2 assert_type</a></td></tr>

38027

38028

38029

<tr><td></td><td valign="top"><a href="#index-Callback-Function"><code>Callback Function</code></a></td><td valign="top"><a href="#Callback-Function">4.3.3 Callback Function</a></td></tr>

38030

<tr><td></td><td valign="top"><a href="#index-custom-resolver"><code>custom resolver</code></a></td><td valign="top"><a href="#Custom-Resolver">13.1.2 Custom Resolver</a></td></tr>

38031

38032

38033

<tr><td></td><td valign="top"><a href="#index-etype"><code>etype</code></a></td><td valign="top"><a href="#etype">5.14.4 etype</a></td></tr>

38034

38035

38036

38037

38038

38039

38040

38041

38042

38043

38044

38045

<tr><td></td><td valign="top"><a href="#index-lib_002eimport"><code>lib.import</code></a></td><td valign="top"><a href="#libimport">12.5 libimport</a></td></tr>

38046

<tr><td></td><td valign="top"><a href="#index-lib_002eimport_002elevel_005fto_005fmap"><code>lib.import.level_to_map</code></a></td><td valign="top"><a href="#lib_002eimport_002elevel_005fto_005fmap">12.5.3 lib.import.level_to_map</a></td></tr>

38047

<tr><td></td><td valign="top"><a href="#index-lib_002eimport_002emap_005fsokoban"><code>lib.import.map_sokoban</code></a></td><td valign="top"><a href="#lib_002eimport_002emap_005fsokoban">12.5.4 lib.import.map_sokoban</a></td></tr>

38048

<tr><td></td><td valign="top"><a href="#index-lib_002eimport_002emap_005fwanderer"><code>lib.import.map_wanderer</code></a></td><td valign="top"><a href="#lib_002eimport_002emap_005fwanderer">12.5.5 lib.import.map_wanderer</a></td></tr>

38049

<tr><td></td><td valign="top"><a href="#index-lib_002eimport_002euncompress_005frle"><code>lib.import.uncompress_rle</code></a></td><td valign="top"><a href="#lib_002eimport_002euncompress_005frle">12.5.2 lib.import.uncompress_rle</a></td></tr>

38050

<tr><td></td><td valign="top"><a href="#index-lib_002eimport_002eunpack_005fmultilevel"><code>lib.import.unpack_multilevel</code></a></td><td valign="top"><a href="#lib_002eimport_002eunpack_005fmultilevel">12.5.1 lib.import.unpack_multilevel</a></td></tr>

38051

<tr><td></td><td valign="top"><a href="#index-lib_002elua_002ecombine_005ftables"><code>lib.lua.combine_tables</code></a></td><td valign="top"><a href="#lib_002elua_002ecombine_005ftables">12.2.1 lib.lua.combine_tables</a></td></tr>

38052

38053

38054

<tr><td></td><td valign="top"><a href="#index-lib_002elua_002eprint_005ftable"><code>lib.lua.print_table</code></a></td><td valign="top"><a href="#lib_002elua_002eprint_005ftable">12.2.4 lib.lua.print_table</a></td></tr>

38055

<tr><td></td><td valign="top"><a href="#index-lib_002elua_002eshuffle"><code>lib.lua.shuffle</code></a></td><td valign="top"><a href="#lib_002elua_002eshuffle">12.2.5 lib.lua.shuffle</a></td></tr>

38056

<tr><td></td><td valign="top"><a href="#index-lib_002elua_002eto_005fstring"><code>lib.lua.to_string</code></a></td><td valign="top"><a href="#lib_002elua_002eto_005fstring">12.2.6 lib.lua.to_string</a></td></tr>

38057

<tr><td></td><td valign="top"><a href="#index-lib_002emap_002econcat_005fhorizontally"><code>lib.map.concat_horizontally</code></a></td><td valign="top"><a href="#Map-Horizontal-Concatenation">12.4.10 Map Horizontal Concatenation</a></td></tr>

38058

<tr><td></td><td valign="top"><a href="#index-lib_002emap_002econcat_005fvertically"><code>lib.map.concat_vertically</code></a></td><td valign="top"><a href="#Map-Vertical-Concatenation">12.4.11 Map Vertical Concatenation</a></td></tr>

38059

<tr><td></td><td valign="top"><a href="#index-lib_002emap_002ecovers"><code>lib.map.covers</code></a></td><td valign="top"><a href="#lib_002emap_002ecovers">12.4.15 lib.map.covers</a></td></tr>

38060

<tr><td></td><td valign="top"><a href="#index-lib_002emap_002edefuse"><code>lib.map.defuse</code></a></td><td valign="top"><a href="#lib_002emap_002edefuse">12.4.16 lib.map.defuse</a></td></tr>

38061

<tr><td></td><td valign="top"><a href="#index-lib_002emap_002eextend"><code>lib.map.extend</code></a></td><td valign="top"><a href="#lib_002emap_002eextend">12.4.17 lib.map.extend</a></td></tr>

38062

<tr><td></td><td valign="top"><a href="#index-lib_002emap_002efuse"><code>lib.map.fuse</code></a></td><td valign="top"><a href="#Map-Fusing">12.4.12 Map Fusing</a></td></tr>

38063

<tr><td></td><td valign="top"><a href="#index-lib_002emap_002eget"><code>lib.map.get</code></a></td><td valign="top"><a href="#Map-Entry-Request">12.4.8 Map Entry Request</a></td></tr>

38064

<tr><td></td><td valign="top"><a href="#index-lib_002emap_002ematch"><code>lib.map.match</code></a></td><td valign="top"><a href="#lib_002emap_002ematch">12.4.18 lib.map.match</a></td></tr>

38065

<tr><td></td><td valign="top"><a href="#index-lib_002emap_002enewMap"><code>lib.map.newMap</code></a></td><td valign="top"><a href="#newMap">12.4.7 newMap</a></td></tr>

38066

<tr><td></td><td valign="top"><a href="#index-lib_002emap_002epaste"><code>lib.map.paste</code></a></td><td valign="top"><a href="#lib_002emap_002epaste">12.4.19 lib.map.paste</a></td></tr>

38067

<tr><td></td><td valign="top"><a href="#index-lib_002emap_002eprint"><code>lib.map.print</code></a></td><td valign="top"><a href="#lib_002emap_002eprint">12.4.20 lib.map.print</a></td></tr>

38068

<tr><td></td><td valign="top"><a href="#index-lib_002emap_002erandom_005ftransformation"><code>lib.map.random_transformation</code></a></td><td valign="top"><a href="#Random-Map-Transformations">12.4.28 Random Map Transformations</a></td></tr>

38069

<tr><td></td><td valign="top"><a href="#index-lib_002emap_002ereplace"><code>lib.map.replace</code></a></td><td valign="top"><a href="#lib_002emap_002ereplace">12.4.21 lib.map.replace</a></td></tr>

38070

<tr><td></td><td valign="top"><a href="#index-lib_002emap_002ereplace_005foutside"><code>lib.map.replace_outside</code></a></td><td valign="top"><a href="#lib_002emap_002ereplace_005foutside">12.4.22 lib.map.replace_outside</a></td></tr>

38071

<tr><td></td><td valign="top"><a href="#index-lib_002emap_002eset"><code>lib.map.set</code></a></td><td valign="top"><a href="#Map-Entry-Request">12.4.8 Map Entry Request</a></td></tr>

38072

<tr><td></td><td valign="top"><a href="#index-lib_002emap_002eset_005fdefault_005fkey"><code>lib.map.set_default_key</code></a></td><td valign="top"><a href="#Map-Default-Keys">12.4.13 Map Default Keys</a></td></tr>

38073

38074

<tr><td></td><td valign="top"><a href="#index-lib_002emap_002etransform"><code>lib.map.transform</code></a></td><td valign="top"><a href="#Map-Transformation">12.4.9 Map Transformation</a></td></tr>

38075

<tr><td></td><td valign="top"><a href="#index-lib_002emap_002etransformation_005fcompose"><code>lib.map.transformation_compose</code></a></td><td valign="top"><a href="#Map-Transformation-Composition-and-Powers">12.4.26 Map Transformation Composition and Powers</a></td></tr>

38076

<tr><td></td><td valign="top"><a href="#index-lib_002emap_002etransformation_005fpower"><code>lib.map.transformation_power</code></a></td><td valign="top"><a href="#Map-Transformation-Composition-and-Powers">12.4.26 Map Transformation Composition and Powers</a></td></tr>

38077

38078

<tr><td></td><td valign="top"><a href="#index-lib_002emath_002ecombinations"><code>lib.math.combinations</code></a></td><td valign="top"><a href="#lib_002emath_002ecombinations">12.3.1 lib.math.combinations</a></td></tr>

38079

<tr><td></td><td valign="top"><a href="#index-lib_002emath_002ecubic_005fpolynomial"><code>lib.math.cubic_polynomial</code></a></td><td valign="top"><a href="#lib_002emath_002ecubic_005fpolynomial">12.3.2 lib.math.cubic_polynomial</a></td></tr>

38080

<tr><td></td><td valign="top"><a href="#index-lib_002emath_002ecyclic_005fpermutation"><code>lib.math.cyclic_permutation</code></a></td><td valign="top"><a href="#lib_002emath_002ecyclic_005fpermutation">12.3.3 lib.math.cyclic_permutation</a></td></tr>

38081

<tr><td></td><td valign="top"><a href="#index-lib_002emath_002edigits"><code>lib.math.digits</code></a></td><td valign="top"><a href="#lib_002emath_002edigits">12.3.4 lib.math.digits</a></td></tr>

38082

<tr><td></td><td valign="top"><a href="#index-lib_002emath_002emanhattan_005fdistance"><code>lib.math.manhattan_distance</code></a></td><td valign="top"><a href="#lib_002emath_002emanhattan_005fdistance">12.3.5 lib.math.manhattan_distance</a></td></tr>

38083

<tr><td></td><td valign="top"><a href="#index-lib_002emath_002emark_005fcomponents"><code>lib.math.mark_components</code></a></td><td valign="top"><a href="#lib_002emath_002emark_005fcomponents">12.3.6 lib.math.mark_components</a></td></tr>

38084

<tr><td></td><td valign="top"><a href="#index-lib_002emath_002epermutation"><code>lib.math.permutation</code></a></td><td valign="top"><a href="#lib_002emath_002epermutation">12.3.7 lib.math.permutation</a></td></tr>

38085

<tr><td></td><td valign="top"><a href="#index-lib_002emath_002erandom_005fvector"><code>lib.math.random_vector</code></a></td><td valign="top"><a href="#lib_002emath_002erandom_005fvector">12.3.8 lib.math.random_vector</a></td></tr>

38086

<tr><td></td><td valign="top"><a href="#index-lib_002emath_002esteps"><code>lib.math.steps</code></a></td><td valign="top"><a href="#lib_002emath_002esteps">12.3.9 lib.math.steps</a></td></tr>

38087

<tr><td></td><td valign="top"><a href="#index-lib_002emaze_002erenderer_005fstandard"><code>lib.maze.renderer_standard</code></a></td><td valign="top"><a href="#res_002emaze">13.1.5 res.maze</a></td></tr>

38088

<tr><td></td><td valign="top"><a href="#index-lib_002emaze_002erenderer_005fstrip"><code>lib.maze.renderer_strip</code></a></td><td valign="top"><a href="#res_002emaze">13.1.5 res.maze</a></td></tr>

38089

<tr><td></td><td valign="top"><a href="#index-lib_002emaze_002erenderer_005fwindow"><code>lib.maze.renderer_window</code></a></td><td valign="top"><a href="#res_002emaze">13.1.5 res.maze</a></td></tr>

38090

<tr><td></td><td valign="top"><a href="#index-lib_002esoko_002ecreate_005fsokoball"><code>lib.soko.create_sokoball</code></a></td><td valign="top"><a href="#libsoko">12.6 libsoko</a></td></tr>

38091

38092

38093

<tr><td></td><td valign="top"><a href="#index-random"><code>random</code></a></td><td valign="top"><a href="#random">5.14.9 random</a></td></tr>

38094

<tr><td></td><td valign="top"><a href="#index-res_002eautotile"><code>res.autotile</code></a></td><td valign="top"><a href="#res_002eautotile">13.1.3 res.autotile</a></td></tr>

38095

<tr><td></td><td valign="top"><a href="#index-res_002ecomposer"><code>res.composer</code></a></td><td valign="top"><a href="#res_002ecomposer">13.1.4 res.composer</a></td></tr>

38096

<tr><td></td><td valign="top"><a href="#index-res_002ecomposer_005fimplementation"><code>res.composer_implementation</code></a></td><td valign="top"><a href="#Resolver-Implementation">14.1.2 Resolver Implementation</a></td></tr>

38097

38098

<tr><td></td><td valign="top"><a href="#index-res_002epuzzle"><code>res.puzzle</code></a></td><td valign="top"><a href="#res_002epuzzle">13.1.6 res.puzzle</a></td></tr>

38099

<tr><td></td><td valign="top"><a href="#index-res_002erandom"><code>res.random</code></a></td><td valign="top"><a href="#res_002erandom">13.1.7 res.random</a></td></tr>

38100

<tr><td></td><td valign="top"><a href="#index-res_002eresolvername"><code>res.resolvername</code></a></td><td valign="top"><a href="#Resolver-Configurator">14.1.1 Resolver Configurator</a></td></tr>

38101

<tr><td></td><td valign="top"><a href="#index-res_002eresolver_005ffinalization"><code>res.resolver_finalization</code></a></td><td valign="top"><a href="#Resolver-Finalizer">14.1.3 Resolver Finalizer</a></td></tr>

38102

<tr><td></td><td valign="top"><a href="#index-res_002etrain"><code>res.train</code></a></td><td valign="top"><a href="#res_002etrain">13.1.8 res.train</a></td></tr>

38103

38104

38105

38106

38107

38108

<tr><td></td><td valign="top"><a href="#index-usertype"><code>usertype</code></a></td><td valign="top"><a href="#usertype">5.14.11 usertype</a></td></tr>

38109

38110

</table>

38111

38112

38113

38114

38115

38116

38117

38118

38119

38120

38121

38122

38123

38124

38125

38126

38127

38128

38129

38130

38131

</td></tr></table>

38132

38133

38134

38135

38136

38137

38138

38139

38140

38141

38142

38143

38144

38145

38146

38147

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

38148

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

38149

38150

</tr></table>

38151

38152

<h1 class="unnumbered">Concept Index</h1>

38153

38154

38155

38156

38157

38158

38159

38160

38161

38162

38163

38164

38165

38166

38167

38168

38169

38170

38171

38172

38173

38174

38175

38176

38177

38178

38179

38180

38181

38182

</td></tr></table>

38183

38184

<tr><td></td><th align="left">Index Entry</th><th align="left"> Section</th></tr>

38185

38186

38187

<tr><td></td><td valign="top"><a href="#index-abstract-kind">abstract kind</a></td><td valign="top"><a href="#Object-Kind">4.2.1 Object Kind</a></td></tr>

38188

<tr><td></td><td valign="top"><a href="#index-auto-naming">auto naming</a></td><td valign="top"><a href="#Object-Naming">4.2.3 Object Naming</a></td></tr>

38189

38190

38191

<tr><td></td><td valign="top"><a href="#index-callback-function">callback function</a></td><td valign="top"><a href="#Callback-Function">4.3.3 Callback Function</a></td></tr>

38192

<tr><td></td><td valign="top"><a href="#index-crossindex">crossindex</a></td><td valign="top"><a href="#Levelpack-Basics">2. Levelpack Basics</a></td></tr>

38193

<tr><td></td><td valign="top"><a href="#index-crossreference">crossreference</a></td><td valign="top"><a href="#Levelpack-Basics">2. Levelpack Basics</a></td></tr>

38194

38195

38196

<tr><td></td><td valign="top"><a href="#index-default-floor">default floor</a></td><td valign="top"><a href="#Object-Layers">4.1.2 Object Layers</a></td></tr>

38197

38198

38199

<tr><td></td><td valign="top"><a href="#index-flood">flood</a></td><td valign="top"><a href="#Flood-Spreading">13.2.2 Flood Spreading</a></td></tr>

38200

38201

38202

<tr><td></td><td valign="top"><a href="#index-grid-position">grid position</a></td><td valign="top"><a href="#World_0027s-Shape-and-Coordinates">4.1.1 World’s Shape and Coordinates</a></td></tr>

38203

38204

38205

<tr><td></td><td valign="top"><a href="#index-index">index</a></td><td valign="top"><a href="#Levelpack-Basics">2. Levelpack Basics</a></td></tr>

38206

38207

38208

<tr><td></td><td valign="top"><a href="#index-l10n-path">l10n path</a></td><td valign="top"><a href="#Locating-Resources">1.1 Locating Resources</a></td></tr>

38209

<tr><td></td><td valign="top"><a href="#index-layer">layer</a></td><td valign="top"><a href="#Object-Layers">4.1.2 Object Layers</a></td></tr>

38210

<tr><td></td><td valign="top"><a href="#index-levelinspector">levelinspector</a></td><td valign="top"><a href="#Level-Info">1.5 Level Info</a></td></tr>

38211

<tr><td></td><td valign="top"><a href="#index-levelpack">levelpack</a></td><td valign="top"><a href="#Levelpack-Basics">2. Levelpack Basics</a></td></tr>

38212

<tr><td></td><td valign="top"><a href="#index-localization-path">localization path</a></td><td valign="top"><a href="#Locating-Resources">1.1 Locating Resources</a></td></tr>

38213

38214

38215

<tr><td></td><td valign="top"><a href="#index-nearest-object">nearest object</a></td><td valign="top"><a href="#Object-Naming">4.2.3 Object Naming</a></td></tr>

38216

38217

38218

<tr><td></td><td valign="top"><a href="#index-onescreener">onescreener</a></td><td valign="top"><a href="#World_0027s-Shape-and-Coordinates">4.1.1 World’s Shape and Coordinates</a></td></tr>

38219

<tr><td></td><td valign="top"><a href="#index-overloading">overloading</a></td><td valign="top"><a href="#Polymorphism-and-Overloading">5.4.3 Polymorphism and Overloading</a></td></tr>

38220

38221

38222

<tr><td></td><td valign="top"><a href="#index-polymorphism">polymorphism</a></td><td valign="top"><a href="#Polymorphism-and-Overloading">5.4.3 Polymorphism and Overloading</a></td></tr>

38223

<tr><td></td><td valign="top"><a href="#index-position">position</a></td><td valign="top"><a href="#World_0027s-Shape-and-Coordinates">4.1.1 World’s Shape and Coordinates</a></td></tr>

38224

<tr><td></td><td valign="top"><a href="#index-preferences-path">preferences path</a></td><td valign="top"><a href="#Locating-Resources">1.1 Locating Resources</a></td></tr>

38225

38226

38227

<tr><td></td><td valign="top"><a href="#index-resource-paths">resource paths</a></td><td valign="top"><a href="#Locating-Resources">1.1 Locating Resources</a></td></tr>

38228

38229

38230

<tr><td></td><td valign="top"><a href="#index-system-path">system path</a></td><td valign="top"><a href="#Locating-Resources">1.1 Locating Resources</a></td></tr>

38231

38232

38233

<tr><td></td><td valign="top"><a href="#index-target-action-paradigm">target action paradigm</a></td><td valign="top"><a href="#Target-_002d-Action">4.3.2 Target - Action</a></td></tr>

38234

<tr><td></td><td valign="top"><a href="#index-tile">tile</a></td><td valign="top"><a href="#World_0027s-Shape-and-Coordinates">4.1.1 World’s Shape and Coordinates</a></td></tr>

38235

38236

38237

<tr><td></td><td valign="top"><a href="#index-user-image-path">user image path</a></td><td valign="top"><a href="#Locating-Resources">1.1 Locating Resources</a></td></tr>

38238

<tr><td></td><td valign="top"><a href="#index-user-path">user path</a></td><td valign="top"><a href="#Locating-Resources">1.1 Locating Resources</a></td></tr>

38239

38240

</table>

38241

38242

38243

38244

38245

38246

38247

38248

38249

38250

38251

38252

38253

38254

38255

38256

38257

38258

38259

38260

38261

38262

38263

38264

38265

38266

38267

38268

38269

</td></tr></table>

38270

38271

38272

38273

38274

38275

38276

38277

38278

38279

38280

38281

38282

38283

38284

38285

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

38286

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

38287

38288

</tr></table>

38289

38290

<h1 class="unnumbered">Renaming Index</h1>

38291

38292

38293

<dt> ac-blackball → <code>ac_marble_black</code>, see section <a href="#ac_005fmarble">ac_marble</a></dt>

38294

38295

<dt> ac-horse → <a href="#ac_005fhorse">ac_horse</a></dt>

38296

<dt> ac-killerball → <a href="#ac_005fkiller">ac_killer</a></dt>

38297

<dt> ac-rotor → <a href="#ac_005frotor">ac_rotor</a></dt>

38298

38299

<dt> ac-whiteball → <code>ac_marble_white</code>, see section <a href="#ac_005fmarble">ac_marble</a></dt>

38300

<dt> ac-whiteball-small → <code>ac_pearl_white, owner=DEFAULT</code>, see section <a href="#ac_005fpearl">ac_pearl</a></dt>

38301

<dt> fl-abyss → <a href="#fl_005fabyss">fl_abyss</a></dt>

38302

<dt> fl-abyss_fake → <code>fl_fake_abyss</code>, see section <a href="#fl_005ffake">fl_fake</a></dt>

38303

<dt> fl-acblack → <code>fl_yinyang_yin</code>, see section <a href="#fl_005fyinyang">fl_yinyang</a></dt>

38304

<dt> fl-acwhite → <code>fl_yinyang_yang</code>, see section <a href="#fl_005fyinyang">fl_yinyang</a></dt>

38305

<dt> fl-black → <a href="#fl_005fdark">fl_dark</a></dt>

38306

<dt> fl-bluegray → <a href="#fl_005fbluegray">fl_bluegray</a></dt>

38307

<dt> fl-bluegreen → <a href="#fl_005fbluegreen">fl_bluegreen</a></dt>

38308

<dt> fl-bluegreenx → <a href="#fl_005faquamarine">fl_aquamarine</a></dt>

38309

<dt> fl-brick → <a href="#fl_005fbrick">fl_brick</a></dt>

38310

<dt> fl-bridge → <a href="#fl_005fbridge">fl_bridge</a></dt>

38311

<dt> fl-bridge-closed → <code>fl_bridge, state=CLOSED</code>, see section <a href="#fl_005fbridge">fl_bridge</a></dt>

38312

<dt> fl-bridge-open → <a href="#fl_005fbridge">fl_bridge</a></dt>

38313

<dt> fl-bumps → <a href="#fl_005fpinkbumps">fl_pinkbumps</a></dt>

38314

<dt> fl-concrete → <a href="#fl_005fconcrete">fl_concrete</a></dt>

38315

<dt> fl-darkgray → <a href="#fl_005fdarkgray">fl_darkgray</a></dt>

38316

<dt> fl-dunes → <a href="#fl_005fdunes">fl_dunes</a></dt>

38317

<dt> fl-floor_001 → <a href="#fl_005fbast">fl_bast</a></dt>

38318

<dt> fl-gradient → <code>fl_slope_ps</code>, see section <a href="#fl_005fslope">fl_slope</a></dt>

38319

<dt> fl-gradient1 → <code>fl_slope_ps</code>, see section <a href="#fl_005fslope">fl_slope</a></dt>

38320

<dt> fl-gradient2 → <code>fl_slope_pn</code>, see section <a href="#fl_005fslope">fl_slope</a></dt>

38321

<dt> fl-gradient3 → <code>fl_slope_pe</code>, see section <a href="#fl_005fslope">fl_slope</a></dt>

38322

<dt> fl-gradient4 → <code>fl_slope_pw</code>, see section <a href="#fl_005fslope">fl_slope</a></dt>

38323

<dt> fl-gradient5 → <code>fl_slope_ose</code>, see section <a href="#fl_005fslope">fl_slope</a></dt>

38324

<dt> fl-gradient6 → <code>fl_slope_osw</code>, see section <a href="#fl_005fslope">fl_slope</a></dt>

38325

<dt> fl-gradient7 → <code>fl_slope_one</code>, see section <a href="#fl_005fslope">fl_slope</a></dt>

38326

<dt> fl-gradient8 → <code>fl_slope_onw</code>, see section <a href="#fl_005fslope">fl_slope</a></dt>

38327

<dt> fl-gradient9 → <code>fl_slope_ise</code>, see section <a href="#fl_005fslope">fl_slope</a></dt>

38328

<dt> fl-gradient10 → <code>fl_slope_ine</code>, see section <a href="#fl_005fslope">fl_slope</a></dt>

38329

<dt> fl-gradient11 → <code>fl_slope_isw</code>, see section <a href="#fl_005fslope">fl_slope</a></dt>

38330

<dt> fl-gradient12 → <code>fl_slope_inw</code>, see section <a href="#fl_005fslope">fl_slope</a></dt>

38331

<dt> fl-gradient13 → <code>fl_slope_tn</code>, see section <a href="#fl_005fslope">fl_slope</a></dt>

38332

<dt> fl-gradient14 → <code>fl_slope_ts</code>, see section <a href="#fl_005fslope">fl_slope</a></dt>

38333

<dt> fl-gradient15 → <code>fl_slope_tw</code>, see section <a href="#fl_005fslope">fl_slope</a></dt>

38334

<dt> fl-gradient16 → <code>fl_slope_te</code>, see section <a href="#fl_005fslope">fl_slope</a></dt>

38335

<dt> fl-gravel → <a href="#fl_005fgravel">fl_gravel</a></dt>

38336

38337

38338

<dt> fl-himalaya → <a href="#fl_005fhimalaya">fl_himalaya</a></dt>

38339

38340

<dt> fl-inverse → <code>fl_inverse_white</code>, see section <a href="#fl_005finverse">fl_inverse</a></dt>

38341

<dt> fl-inverse2 → <code>fl_inverse_gray</code>, see section <a href="#fl_005finverse">fl_inverse</a></dt>

38342

<dt> fl-leaves → <code>fl_lawn_a</code>, see section <a href="#fl_005flawn">fl_lawn</a></dt>

38343

<dt> fl-leavesb → <code>fl_lawn_b</code>, see section <a href="#fl_005flawn">fl_lawn</a></dt>

38344

<dt> fl-leavesc1 → <code>fl_lawn_c1</code>, see section <a href="#fl_005flawn">fl_lawn</a></dt>

38345

<dt> fl-leavesc2 → <code>fl_lawn_c2</code>, see section <a href="#fl_005flawn">fl_lawn</a></dt>

38346

<dt> fl-leavesc3 → <code>fl_lawn_c3</code>, see section <a href="#fl_005flawn">fl_lawn</a></dt>

38347

<dt> fl-leavesc4 → <code>fl_lawn_c4</code>, see section <a href="#fl_005flawn">fl_lawn</a></dt>

38348

<dt> fl-leavesd1 → <code>fl_lawn_d1</code>, see section <a href="#fl_005flawn">fl_lawn</a></dt>

38349

<dt> fl-leavesd2 → <code>fl_lawn_d2</code>, see section <a href="#fl_005flawn">fl_lawn</a></dt>

38350

<dt> fl-leavesd3 → <code>fl_lawn_d3</code>, see section <a href="#fl_005flawn">fl_lawn</a></dt>

38351

<dt> fl-leavesd4 → <code>fl_lawn_d4</code>, see section <a href="#fl_005flawn">fl_lawn</a></dt>

38352

<dt> fl-leavese1 → <code>fl_lawn_e1</code>, see section <a href="#fl_005flawn">fl_lawn</a></dt>

38353

<dt> fl-leavese2 → <code>fl_lawn_e2</code>, see section <a href="#fl_005flawn">fl_lawn</a></dt>

38354

<dt> fl-leavese3 → <code>fl_lawn_e3</code>, see section <a href="#fl_005flawn">fl_lawn</a></dt>

38355

<dt> fl-leavese4 → <code>fl_lawn_e4</code>, see section <a href="#fl_005flawn">fl_lawn</a></dt>

38356

<dt> fl-light → <a href="#fl_005fivory">fl_ivory</a></dt>

38357

<dt> fl-lightgray → <a href="#fl_005fplatinum">fl_platinum</a></dt>

38358

<dt> fl-marble → <a href="#fl_005fmarble">fl_marble</a></dt>

38359

<dt> fl-metal → <a href="#fl_005fmetal">fl_metal</a></dt>

38360

<dt> fl-metal1 → <code>fl_metal_1</code>, see section <a href="#fl_005fmetal">fl_metal</a></dt>

38361

<dt> fl-metal2 → <code>fl_metal_2</code>, see section <a href="#fl_005fmetal">fl_metal</a></dt>

38362

<dt> fl-metal3 → <code>fl_metal_3</code>, see section <a href="#fl_005fmetal">fl_metal</a></dt>

38363

<dt> fl-metal4 → <code>fl_metal_4</code>, see section <a href="#fl_005fmetal">fl_metal</a></dt>

38364

<dt> fl-metal5 → <code>fl_metal_5</code>, see section <a href="#fl_005fmetal">fl_metal</a></dt>

38365

<dt> fl-metal6 → <code>fl_metal_6</code>, see section <a href="#fl_005fmetal">fl_metal</a></dt>

38366

<dt> fl-mortar → <a href="#fl_005fmortar">fl_mortar</a></dt>

38367

<dt> fl-nomouse → <a href="#fl_005fadhesionless">fl_adhesionless</a></dt>

38368

<dt> fl-normal_x → <code>fl_metal_7</code>, see section <a href="#fl_005fmetal">fl_metal</a></dt>

38369

<dt> fl-normal → <code>fl_metal_7n</code>, see section <a href="#fl_005fmetal">fl_metal</a></dt>

38370

<dt> fl-plank → <a href="#fl_005fplank">fl_plank</a></dt>

38371

38372

38373

<dt> fl-rough → <a href="#fl_005frough">fl_rough</a></dt>

38374

<dt> fl-rough_medium → <code>fl_rough, friction=5.0, adhesion=1.2</code>, see section <a href="#fl_005frough">fl_rough</a></dt>

38375

<dt> fl-rough_slow → <code>fl_rough, friction=7.0, adhesion=0.5</code>, see section <a href="#fl_005frough">fl_rough</a></dt>

38376

<dt> fl-rough-blue → <a href="#fl_005fblueslab">fl_blueslab</a></dt>

38377

<dt> fl-rough-red → <a href="#fl_005fredslab">fl_redslab</a></dt>

38378

<dt> fl-sahara → <a href="#fl_005fsahara">fl_sahara</a></dt>

38379

<dt> fl-samba → <a href="#fl_005fsamba">fl_samba</a></dt>

38380

<dt> fl-samba1 → <code>fl_samba_h</code>, see section <a href="#fl_005fsamba">fl_samba</a></dt>

38381

<dt> fl-samba2 → <code>fl_samba_v</code>, see section <a href="#fl_005fsamba">fl_samba</a></dt>

38382

38383

<dt> fl-space → <a href="#fl_005fspace">fl_space</a></dt>

38384

<dt> fl-springboard → <a href="#fl_005fwhite">fl_white</a></dt>

38385

<dt> fl-stone → <a href="#fl_005fstone">fl_stone</a></dt>

38386

<dt> fl-stwood → <code>fl_wood_framed</code>, see section <a href="#fl_005fwood">fl_wood</a></dt>

38387

<dt> fl-stwood1 → <code>fl_wood_framed_h</code>, see section <a href="#fl_005fwood">fl_wood</a></dt>

38388

<dt> fl-stwood2 → <code>fl_wood_framed_v</code>, see section <a href="#fl_005fwood">fl_wood</a></dt>

38389

<dt> fl-swamp → <a href="#fl_005fswamp">fl_swamp</a></dt>

38390

<dt> fl-thief → <a href="#fl_005fthief">fl_thief</a></dt>

38391

<dt> fl-tigris → <a href="#fl_005ftigris">fl_tigris</a></dt>

38392

<dt> fl-trigger → <code>fl_fake_trigger</code>, see section <a href="#fl_005ffake">fl_fake</a></dt>

38393

<dt> fl-water → <a href="#fl_005fwater">fl_water</a></dt>

38394

<dt> fl-white → <a href="#fl_005fbright">fl_bright</a></dt>

38395

38396

<dt> fl-wood1 → <code>fl_wood_h</code>, see section <a href="#fl_005fwood">fl_wood</a></dt>

38397

<dt> fl-wood2 → <code>fl_wood_v</code>, see section <a href="#fl_005fwood">fl_wood</a></dt>

38398

<dt> fl-woven → <a href="#fl_005fwoven">fl_woven</a></dt>

38399

<dt> it-abyss → <a href="#it_005ftrap">it_trap</a></dt>

38400

38401

<dt> it-banana → <a href="#it_005fbanana">it_banana</a></dt>

38402

<dt> it-blackbomb → <code>it_bomb_black</code>, see section <a href="#it_005fbomb">it_bomb</a></dt>

38403

<dt> it-blocker → <a href="#it_005fblocker">it_blocker</a></dt>

38404

<dt> it-blocker-new → <code>it_blocker_new</code>, see section <a href="#it_005fblocker">it_blocker</a></dt>

38405

<dt> it-booze → <a href="#it_005fbottle">it_bottle</a></dt>

38406

<dt> it-booze-broken → <code>it_bottle_broken</code>, see section <a href="#it_005fbottle">it_bottle</a></dt>

38407

<dt> it-brake → <a href="#it_005fbrake">it_brake</a></dt>

38408

<dt> it-brush → <a href="#it_005fbrush">it_brush</a></dt>

38409

<dt> it-burnable → <a href="#it_005fburnable">it_burnable</a></dt>

38410

<dt> it-burnable_ash → <code>it_burnable_ash</code>, see section <a href="#it_005fburnable">it_burnable</a></dt>

38411

<dt> it-burnable_burning → <code>it_burnable_burning</code>, see section <a href="#it_005fburnable">it_burnable</a></dt>

38412

<dt> it-burnable_fireproof → <code>it_burnable_fireproof</code>, see section <a href="#it_005fburnable">it_burnable</a></dt>

38413

<dt> it-burnable_ignited → <code>it_burnable_ignited</code>, see section <a href="#it_005fburnable">it_burnable</a></dt>

38414

<dt> it-burnable_oil → <code>it_burnable_oil</code>, see section <a href="#it_005fburnable">it_burnable</a></dt>

38415

<dt> it-cherry → <a href="#it_005fcherry">it_cherry</a></dt>

38416

<dt> it-coffee → <a href="#it_005fcoffee">it_coffee</a></dt>

38417

<dt> it-coin1 → <code>it_coin_s</code>, see section <a href="#it_005fcoin">it_coin</a></dt>

38418

<dt> it-coin2 → <code>it_coin_m</code>, see section <a href="#it_005fcoin">it_coin</a></dt>

38419

<dt> it-coin4 → <code>it_coin_l</code>, see section <a href="#it_005fcoin">it_coin</a></dt>

38420

<dt> it-crack0 → <code>it_crack_i</code>, see section <a href="#it_005fcrack">it_crack</a></dt>

38421

<dt> it-crack1 → <code>it_crack_s</code>, see section <a href="#it_005fcrack">it_crack</a></dt>

38422

<dt> it-crack2 → <code>it_crack_m</code>, see section <a href="#it_005fcrack">it_crack</a></dt>

38423

<dt> it-crack3 → <code>it_crack_l</code>, see section <a href="#it_005fcrack">it_crack</a></dt>

38424

<dt> it-cross → <a href="#it_005fcross">it_cross</a></dt>

38425

<dt> it-death → <a href="#it_005fdeath">it_death</a></dt>

38426

<dt> it-document → <a href="#it_005fdocument">it_document</a></dt>

38427

38428

<dt> it-dynamite → <a href="#it_005fdynamite">it_dynamite</a></dt>

38429

<dt> it-explosion1 → <code>it_explosion_nil</code>, see section <a href="#it_005fexplosion">it_explosion</a></dt>

38430

<dt> it-explosion2 → <code>it_explosion_hollow</code>, see section <a href="#it_005fexplosion">it_explosion</a></dt>

38431

<dt> it-explosion3 → <code>it_explosion_debris</code>, see section <a href="#it_005fexplosion">it_explosion</a></dt>

38432

<dt> it-extinguisher → <a href="#it_005fextinguisher">it_extinguisher</a></dt>

38433

<dt> it-extinguisher_empty → <code>it_extinguisher_empty</code>, see section <a href="#it_005fextinguisher">it_extinguisher</a></dt>

38434

<dt> it-extinguisher_medium → <code>it_extinguisher_medium</code>, see section <a href="#it_005fextinguisher">it_extinguisher</a></dt>

38435

<dt> it-extralife → <a href="#it_005fextralife">it_extralife</a></dt>

38436

<dt> it-flagblack → <code>it_flag_black</code>, see section <a href="#it_005fflag">it_flag</a></dt>

38437

<dt> it-flagwhite → <code>it_flag_white</code>, see section <a href="#it_005fflag">it_flag</a></dt>

38438

<dt> it-floppy → <a href="#it_005ffloppy">it_floppy</a></dt>

38439

<dt> it-glasses → <a href="#it_005fglasses">it_glasses</a></dt>

38440

<dt> it-glasses-broken → <code>it_glasses_broken</code>, see section <a href="#it_005fglasses">it_glasses</a></dt>

38441

<dt> it-hammer → <a href="#it_005fhammer">it_hammer</a></dt>

38442

<dt> it-hollow → <code>it_meditation_hollow</code>, see section <a href="#it_005fmeditation">it_meditation</a></dt>

38443

<dt> it-hill → <code>it_meditation_hill</code>, see section <a href="#it_005fmeditation">it_meditation</a></dt>

38444

<dt> it-hstrip → <code>it_strip_ew</code>, see section <a href="#it_005fstrip">it_strip</a></dt>

38445

<dt> it-inversesensor → <code>it_sensor, invisible=true, inverse=true</code>, see section <a href="#it_005fsensor">it_sensor</a></dt>

38446

<dt> it-key → <code>it_key, code=1</code>, see section <a href="#it_005fkey">it_key</a></dt>

38447

<dt> it-key_a → <code>it_key, code=1</code>, see section <a href="#it_005fkey">it_key</a></dt>

38448

<dt> it-key_b → <code>it_key, code=2</code>, see section <a href="#it_005fkey">it_key</a></dt>

38449

<dt> it-key_c → <code>it_key, code=3</code>, see section <a href="#it_005fkey">it_key</a></dt>

38450

<dt> it-landmine → <a href="#it_005flandmine">it_landmine</a></dt>

38451

<dt> it-magicwand → <a href="#it_005fmagicwand">it_magicwand</a></dt>

38452

<dt> it-magnet → <a href="#it_005fmagnet">it_magnet</a></dt>

38453

<dt> it-magnet-on → <code>it_magnet_on</code>, see section <a href="#it_005fmagnet">it_magnet</a></dt>

38454

<dt> it-magnet-off → <code>it_magnet_off</code>, see section <a href="#it_005fmagnet">it_magnet</a></dt>

38455

<dt> it-pencil → <a href="#it_005fpencil">it_pencil</a></dt>

38456

38457

<dt> it-pipe-e → <code>it_pipe_e</code>, see section <a href="#it_005fpipe">it_pipe</a></dt>

38458

<dt> it-pipe-es → <code>it_pipe_es</code>, see section <a href="#it_005fpipe">it_pipe</a></dt>

38459

<dt> it-pipe-h → <code>it_pipe_ew</code>, see section <a href="#it_005fpipe">it_pipe</a></dt>

38460

<dt> it-pipe-n → <code>it_pipe_n</code>, see section <a href="#it_005fpipe">it_pipe</a></dt>

38461

<dt> it-pipe-ne → <code>it_pipe_ne</code>, see section <a href="#it_005fpipe">it_pipe</a></dt>

38462

<dt> it-pipe-s → <code>it_pipe_s</code>, see section <a href="#it_005fpipe">it_pipe</a></dt>

38463

<dt> it-pipe-sw → <code>it_pipe_sw</code>, see section <a href="#it_005fpipe">it_pipe</a></dt>

38464

<dt> it-pipe-v → <code>it_pipe_ns</code>, see section <a href="#it_005fpipe">it_pipe</a></dt>

38465

<dt> it-pipe-w → <code>it_pipe_w</code>, see section <a href="#it_005fpipe">it_pipe</a></dt>

38466

<dt> it-pipe-wn → <code>it_pipe_nw</code>, see section <a href="#it_005fpipe">it_pipe</a></dt>

38467

<dt> it-puller-e → <code>it_puller_e</code>, see section <a href="#it_005fpuller">it_puller</a></dt>

38468

<dt> it-puller-n → <code>it_puller_n</code>, see section <a href="#it_005fpuller">it_puller</a></dt>

38469

<dt> it-puller-s → <code>it_puller_s</code>, see section <a href="#it_005fpuller">it_puller</a></dt>

38470

<dt> it-puller-w → <code>it_puller_w</code>, see section <a href="#it_005fpuller">it_puller</a></dt>

38471

38472

<dt> it-rubberband → <a href="#it_005frubberband">it_rubberband</a></dt>

38473

<dt> it-seed → <code>it_seed_wood</code>, see section <a href="#it_005fseed">it_seed</a></dt>

38474

<dt> it-seed_nowood → <code>it_seed_fake</code>, see section <a href="#it_005fseed">it_seed</a></dt>

38475

<dt> it-seed_volcano → <code>it_seed_volcano</code>, see section <a href="#it_005fseed">it_seed</a></dt>

38476

<dt> it-sensor → <code>it_sensor, invisible=true</code>, see section <a href="#it_005fsensor">it_sensor</a></dt>

38477

<dt> it-spade → <a href="#it_005fspade">it_spade</a></dt>

38478

<dt> it-spoon → <a href="#it_005fspoon">it_spoon</a></dt>

38479

<dt> it-spring1 → <code>it_spring_keep</code>, see section <a href="#it_005fspring">it_spring</a></dt>

38480

<dt> it-spring2 → <code>it_spring_drop</code>, see section <a href="#it_005fspring">it_spring</a></dt>

38481

<dt> it-springboard → <a href="#it_005fspringboard">it_springboard</a></dt>

38482

<dt> it-squashed → <a href="#it_005fsquashed">it_squashed</a></dt>

38483

<dt> it-shogun-s → <code>it_shogun_s</code>, see section <a href="#it_005fshogun">it_shogun</a></dt>

38484

<dt> it-shogun-m → <code>it_shogun_m</code>, see section <a href="#it_005fshogun">it_shogun</a></dt>

38485

<dt> it-shogun-l → <code>it_shogun_l</code>, see section <a href="#it_005fshogun">it_shogun</a></dt>

38486

<dt> it-surprise → <a href="#it_005fsurprise">it_surprise</a></dt>

38487

<dt> it-sword → <a href="#it_005fsword">it_sword</a></dt>

38488

<dt> it-tinyhollow → <code>it_meditation_dent</code>, see section <a href="#it_005fmeditation">it_meditation</a></dt>

38489

<dt> it-tinyhill → <code>it_meditation_bump</code>, see section <a href="#it_005fmeditation">it_meditation</a></dt>

38490

<dt> it-trigger → <a href="#it_005ftrigger">it_trigger</a></dt>

38491

<dt> it-umbrella → <a href="#it_005fumbrella">it_umbrella</a></dt>

38492

<dt> it-vortex-open → <code>it_vortex_open, scissor=false</code>, see section <a href="#it_005fvortex">it_vortex</a></dt>

38493

<dt> it-vortex-closed → <code>it_vortex_closed, autoclose=true, scissor=false</code>, see section <a href="#it_005fvortex">it_vortex</a></dt>

38494

<dt> it-vstrip → <code>it_strip_ns</code>, see section <a href="#it_005fstrip">it_strip</a></dt>

38495

<dt> it-weight → <a href="#it_005fweight">it_weight</a></dt>

38496

<dt> it-whitebomb → <code>it_bomb_white</code>, see section <a href="#it_005fbomb">it_bomb</a></dt>

38497

<dt> it-wormhole → <code>it_wormhole_on, scissor=false</code>, see section <a href="#it_005fwormhole">it_wormhole</a></dt>

38498

<dt> it-wormhole-off → <code>it_wormhole_off, scissor=false</code>, see section <a href="#it_005fwormhole">it_wormhole</a></dt>

38499

<dt> it-wrench → <a href="#it_005fwrench">it_wrench</a></dt>

38500

<dt> it-yinyang → <a href="#it_005fyinyang">it_yinyang</a></dt>

38501

<dt> st-actorimpulse → <a href="#st_005factorimpulse">st_actorimpulse</a></dt>

38502

<dt> st-actorimpulse_invisible → <code>st_actorimpulse_invisible</code>, see section <a href="#st_005factorimpulse">st_actorimpulse</a></dt>

38503

<dt> st-beads → <a href="#st_005fbeads">st_beads</a></dt>

38504

<dt> st-bigbluesand-e → <code>st_bluesand_e</code>, see section <a href="#st_005fbluesand">st_bluesand</a></dt>

38505

<dt> st-bigbluesand-es → <code>st_bluesand_es</code>, see section <a href="#st_005fbluesand">st_bluesand</a></dt>

38506

<dt> st-bigbluesand-esw → <code>st_bluesand_esw</code>, see section <a href="#st_005fbluesand">st_bluesand</a></dt>

38507

<dt> st-bigbluesand-ew → <code>st_bluesand_ew</code>, see section <a href="#st_005fbluesand">st_bluesand</a></dt>

38508

<dt> st-bigbluesand-n → <code>st_bluesand_n</code>, see section <a href="#st_005fbluesand">st_bluesand</a></dt>

38509

<dt> st-bigbluesand-ne → <code>st_bluesand_ne</code>, see section <a href="#st_005fbluesand">st_bluesand</a></dt>

38510

<dt> st-bigbluesand-nes → <code>st_bluesand_nes</code>, see section <a href="#st_005fbluesand">st_bluesand</a></dt>

38511

<dt> st-bigbluesand-nesw → <code>st_bluesand_nesw</code>, see section <a href="#st_005fbluesand">st_bluesand</a></dt>

38512

<dt> st-bigbluesand-new → <code>st_bluesand_new</code>, see section <a href="#st_005fbluesand">st_bluesand</a></dt>

38513

<dt> st-bigbluesand-ns → <code>st_bluesand_ns</code>, see section <a href="#st_005fbluesand">st_bluesand</a></dt>

38514

<dt> st-bigbluesand-nsw → <code>st_bluesand_nsw</code>, see section <a href="#st_005fbluesand">st_bluesand</a></dt>

38515

<dt> st-bigbluesand-nw → <code>st_bluesand_nw</code>, see section <a href="#st_005fbluesand">st_bluesand</a></dt>

38516

<dt> st-bigbluesand-s → <code>st_bluesand_s</code>, see section <a href="#st_005fbluesand">st_bluesand</a></dt>

38517

<dt> st-bigbluesand-sw → <code>st_bluesand_sw</code>, see section <a href="#st_005fbluesand">st_bluesand</a></dt>

38518

<dt> st-bigbluesand-w → <code>st_bluesand_w</code>, see section <a href="#st_005fbluesand">st_bluesand</a></dt>

38519

<dt> st-bigbrick-e → <code>st_brick_e</code>, see section <a href="#st_005fbrick">st_brick</a></dt>

38520

<dt> st-bigbrick-es → <code>st_brick_es</code>, see section <a href="#st_005fbrick">st_brick</a></dt>

38521

<dt> st-bigbrick-esw → <code>st_brick_esw</code>, see section <a href="#st_005fbrick">st_brick</a></dt>

38522

<dt> st-bigbrick-ew → <code>st_brick_ew</code>, see section <a href="#st_005fbrick">st_brick</a></dt>

38523

<dt> st-bigbrick-n → <code>st_brick_n</code>, see section <a href="#st_005fbrick">st_brick</a></dt>

38524

<dt> st-bigbrick-ne → <code>st_brick_ne</code>, see section <a href="#st_005fbrick">st_brick</a></dt>

38525

<dt> st-bigbrick-nes → <code>st_brick_nes</code>, see section <a href="#st_005fbrick">st_brick</a></dt>

38526

<dt> st-bigbrick-nesw → <code>st_brick_nesw</code>, see section <a href="#st_005fbrick">st_brick</a></dt>

38527

<dt> st-bigbrick-new → <code>st_brick_new</code>, see section <a href="#st_005fbrick">st_brick</a></dt>

38528

<dt> st-bigbrick-ns → <code>st_brick_ns</code>, see section <a href="#st_005fbrick">st_brick</a></dt>

38529

<dt> st-bigbrick-nsw → <code>st_brick_nsw</code>, see section <a href="#st_005fbrick">st_brick</a></dt>

38530

<dt> st-bigbrick-nw → <code>st_brick_nw</code>, see section <a href="#st_005fbrick">st_brick</a></dt>

38531

<dt> st-bigbrick-s → <code>st_brick_s</code>, see section <a href="#st_005fbrick">st_brick</a></dt>

38532

<dt> st-bigbrick-sw → <code>st_brick_sw</code>, see section <a href="#st_005fbrick">st_brick</a></dt>

38533

<dt> st-bigbrick-w → <code>st_brick_w</code>, see section <a href="#st_005fbrick">st_brick</a></dt>

38534

<dt> st-blackballs → <code>st_jamb_black</code>, see section <a href="#st_005fjamb">st_jamb</a></dt>

38535

<dt> st-black1 → <code>st_passage_black_square</code>, see section <a href="#st_005fpassage">st_passage</a></dt>

38536

<dt> st-black2 → <code>st_passage_black_slash</code>, see section <a href="#st_005fpassage">st_passage</a></dt>

38537

<dt> st-black3 → <code>st_passage_black_cross</code>, see section <a href="#st_005fpassage">st_passage</a></dt>

38538

<dt> st-black4 → <code>st_passage_black_frame</code>, see section <a href="#st_005fpassage">st_passage</a></dt>

38539

<dt> st-block → <a href="#st_005fplop">st_plop</a></dt>

38540

<dt> st-blocker → <a href="#st_005fblocker">st_blocker</a></dt>

38541

<dt> st-blocker-growing → <code>st_blocker_new</code>, see section <a href="#st_005fblocker">st_blocker</a></dt>

38542

<dt> st-bluegray → <a href="#st_005fbluegray">st_bluegray</a></dt>

38543

<dt> st-bluegray_hole → <code>st_bluegray_hollow</code>, see section <a href="#st_005fbluegray">st_bluegray</a></dt>

38544

<dt> st-blue-sand → <a href="#st_005fbluesand">st_bluesand</a></dt>

38545

<dt> st-bolder → <a href="#st_005fboulder">st_boulder</a></dt>

38546

<dt> st-bolder-e → <code>st_boulder_e</code>, see section <a href="#st_005fboulder">st_boulder</a></dt>

38547

<dt> st-bolder-n → <code>st_boulder_n</code>, see section <a href="#st_005fboulder">st_boulder</a></dt>

38548

<dt> st-bolder-s → <code>st_boulder_s</code>, see section <a href="#st_005fboulder">st_boulder</a></dt>

38549

<dt> st-bolder-w → <code>st_boulder_w</code>, see section <a href="#st_005fboulder">st_boulder</a></dt>

38550

<dt> st-bombs → <code>st_dispenser_bombblack</code>, see section <a href="#st_005fdispenser">st_dispenser</a></dt>

38551

<dt> st-brake → <a href="#st_005fbrake">st_brake</a></dt>

38552

<dt> st-break_acblack → <code>st_break_black</code>, see section <a href="#st_005fbreak">st_break</a></dt>

38553

<dt> st-break_acwhite → <code>st_break_white</code>, see section <a href="#st_005fbreak">st_break</a></dt>

38554

<dt> st-break_bolder → <code>st_break_boulder</code>, see section <a href="#st_005fbreak">st_break</a></dt>

38555

<dt> st-break_gray → <code>st_break_plain</code>, see section <a href="#st_005fbreak">st_break</a></dt>

38556

<dt> st-break_invisible → <code>st_ghost_break</code>, see section <a href="#st_005fghost">st_ghost</a></dt>

38557

<dt> st-brick → <a href="#st_005fbrick">st_brick</a></dt>

38558

<dt> st-brick_magic → <code>st_magic_brick</code>, see section <a href="#st_005fmagic">st_magic</a></dt>

38559

<dt> st-brownie → <a href="#st_005fbrownie">st_brownie</a></dt>

38560

<dt> st-bug → <code>st_break_bug</code>, see section <a href="#st_005fbreak">st_break</a></dt>

38561

<dt> st-bumps → <a href="#st_005fpinkbumps">st_pinkbumps</a></dt>

38562

<dt> st-camouflage → <a href="#st_005fcamouflage">st_camouflage</a></dt>

38563

<dt> st-camouflage_hole → <code>st_camouflage_hollow</code>, see section <a href="#st_005fcamouflage">st_camouflage</a></dt>

38564

<dt> st-camouflage_move → <code>st_camouflage_movable</code>, see section <a href="#st_005fcamouflage">st_camouflage</a></dt>

38565

<dt> st-chameleon → <a href="#st_005fchameleon">st_chameleon</a></dt>

38566

<dt> st-chargeminus → <code>st_charge_minus</code>, see section <a href="#st_005fcharge">st_charge</a></dt>

38567

<dt> st-chargeplus → <code>st_charge_plus</code>, see section <a href="#st_005fcharge">st_charge</a></dt>

38568

<dt> st-chargezero → <code>st_charge_zero</code>, see section <a href="#st_005fcharge">st_charge</a></dt>

38569

<dt> st-chess → <a href="#st_005fchess">st_chess</a></dt>

38570

<dt> st-chess_black → <code>st_chess_black</code>, see section <a href="#st_005fchess">st_chess</a></dt>

38571

<dt> st-chess_white → <code>st_chess_white</code>, see section <a href="#st_005fchess">st_chess</a></dt>

38572

<dt> st-coffee → <code>st_magic_oxydc</code>, see section <a href="#st_005fmagic">st_magic</a></dt>

38573

<dt> st-coinslot → <a href="#st_005fcoinslot">st_coinslot</a></dt>

38574

<dt> st-death → <a href="#st_005fdeath">st_death</a></dt>

38575

<dt> st-death_invisible → <code>st_death_invisible</code>, see section <a href="#st_005fdeath">st_death</a></dt>

38576

<dt> st-disco-dark → <code>st_disco_dark</code>, see section <a href="#st_005fdisco">st_disco</a></dt>

38577

<dt> st-disco-light → <code>st_disco_light</code>, see section <a href="#st_005fdisco">st_disco</a></dt>

38578

<dt> st-disco-medium → <code>st_disco_medium</code>, see section <a href="#st_005fdisco">st_disco</a></dt>

38579

<dt> st-door_a → <code>st_door_a</code>, see section <a href="#st_005fdoor">st_door</a></dt>

38580

<dt> st-door_b → <code>st_door_b</code>, see section <a href="#st_005fdoor">st_door</a></dt>

38581

<dt> st-door_c → <code>st_door_c</code>, see section <a href="#st_005fdoor">st_door</a></dt>

38582

<dt> st-door-h → <code>st_door_d, faces="ns"</code>, see section <a href="#st_005fdoor">st_door</a></dt>

38583

<dt> st-door-h-open → <code>st_door_d, faces="ns", state=OPEN</code>, see section <a href="#st_005fdoor">st_door</a></dt>

38584

<dt> st-door-v → <code>st_door_d, faces="ew"</code>, see section <a href="#st_005fdoor">st_door</a></dt>

38585

<dt> st-door-v-open → <code>st_door_d, faces="ew", state=OPEN</code>, see section <a href="#st_005fdoor">st_door</a></dt>

38586

<dt> st-fakeoxyd → <code>st_fake_quake</code>, see section <a href="#st_005ffake">st_fake</a></dt>

38587

<dt> st-fakeoxyda → <code>st_magic_oxyda</code>, see section <a href="#st_005fmagic">st_magic</a></dt>

38588

<dt> st-fart → <a href="#st_005fquake">st_quake</a></dt>

38589

<dt> st-firebreak → <code>st_flat_burnable</code>, see section <a href="#st_005fflat">st_flat</a></dt>

38590

<dt> st-firebreak_move → <code>st_flat_moveburnable</code>, see section <a href="#st_005fflat">st_flat</a></dt>

38591

<dt> st-flash → <a href="#st_005fflash">st_flash</a></dt>

38592

<dt> st-flhay → <code>st_box_hay</code>, see section <a href="#st_005fbox">st_box</a></dt>

38593

<dt> st-floppy → <a href="#st_005ffloppy">st_floppy</a></dt>

38594

<dt> st-flrock → <code>st_box_rock</code>, see section <a href="#st_005fbox">st_box</a></dt>

38595

<dt> st-fourswitch → <a href="#st_005ffourswitch">st_fourswitch</a></dt>

38596

<dt> st-glass → <a href="#st_005frawglass">st_rawglass</a></dt>

38597

<dt> st-glass_move → <code>st_rawglass_movable</code>, see section <a href="#st_005frawglass">st_rawglass</a></dt>

38598

<dt> st-glass1 → <a href="#st_005flightglass">st_lightglass</a></dt>

38599

<dt> st-glass1_hole → <code>st_lightglass_hollow</code>, see section <a href="#st_005flightglass">st_lightglass</a></dt>

38600

<dt> st-glass1_move → <code>st_lightglass_movable</code>, see section <a href="#st_005flightglass">st_lightglass</a></dt>

38601

<dt> st-glass2 → <a href="#st_005fdarkglass">st_darkglass</a></dt>

38602

<dt> st-glass2_hole → <code>st_darkglass_hollow</code>, see section <a href="#st_005fdarkglass">st_darkglass</a></dt>

38603

<dt> st-glass2_move → <code>st_darkglass_movable</code>, see section <a href="#st_005fdarkglass">st_darkglass</a></dt>

38604

<dt> st-glass3 → <a href="#st_005fredfiber">st_redfiber</a></dt>

38605

<dt> st-grate1 → <code>st_grate_cross</code>, see section <a href="#st_005fgrate">st_grate</a></dt>

38606

<dt> st-grate2 → <code>st_grate_framed</code>, see section <a href="#st_005fgrate">st_grate</a></dt>

38607

<dt> st-grate3 → <code>st_portal_horse</code>, see section <a href="#st_005fportal">st_portal</a></dt>

38608

<dt> st-greenbrown → <a href="#st_005fgreenbrown">st_greenbrown</a></dt>

38609

<dt> st-greenbrown_hole → <code>st_greenbrown_hollow</code>, see section <a href="#st_005fgreenbrown">st_greenbrown</a></dt>

38610

<dt> st-greenbrown_move → <code>st_greenbrown_movable</code>, see section <a href="#st_005fgreenbrown">st_greenbrown</a></dt>

38611

<dt> st-invisible → <a href="#st_005finvisible">st_invisible</a></dt>

38612

<dt> st-invisible_hole → <code>st_invisible_hollow</code>, see section <a href="#st_005finvisible">st_invisible</a></dt>

38613

<dt> st-invisible_magic → <code>st_ghost_greenbrown</code>, see section <a href="#st_005fghost">st_ghost</a></dt>

38614

<dt> st-invisible_move → <code>st_invisible_movable</code>, see section <a href="#st_005finvisible">st_invisible</a></dt>

38615

<dt> st-key → <code>st_key, code=0</code>, see section <a href="#st_005fkey">st_key</a></dt>

38616

<dt> st-key_a → <code>st_key, code=1</code>, see section <a href="#st_005fkey">st_key</a></dt>

38617

<dt> st-key_b → <code>st_key, code=2</code>, see section <a href="#st_005fkey">st_key</a></dt>

38618

<dt> st-key_c → <code>st_key, code=3</code>, see section <a href="#st_005fkey">st_key</a></dt>

38619

<dt> st-knight → <a href="#st_005fknight">st_knight</a></dt>

38620

<dt> st-laserbreak → <code>st_break_laser</code>, see section <a href="#st_005fbreak">st_break</a></dt>

38621

<dt> st-laserswitch → <a href="#st_005flaserswitch">st_laserswitch</a></dt>

38622

<dt> st-lasertimeswitch → <a href="#st_005flaserflop">st_laserflop</a></dt>

38623

<dt> st-laser → <code>st_laser_e</code>, see section <a href="#st_005flaser">st_laser</a></dt>

38624

<dt> st-laser-e → <code>st_laser_e</code>, see section <a href="#st_005flaser">st_laser</a></dt>

38625

<dt> st-laser-n → <code>st_laser_n</code>, see section <a href="#st_005flaser">st_laser</a></dt>

38626

<dt> st-laser-s → <code>st_laser_s</code>, see section <a href="#st_005flaser">st_laser</a></dt>

38627

<dt> st-laser-w → <code>st_laser_w</code>, see section <a href="#st_005flaser">st_laser</a></dt>

38628

<dt> st-lightpassenger → <a href="#st_005flightpassenger">st_lightpassenger</a></dt>

38629

<dt> st-lightpassenger_off → <code>st_lightpassenger_off</code>, see section <a href="#st_005flightpassenger">st_lightpassenger</a></dt>

38630

<dt> st-likeoxyda → <code>st_fake_oxyda</code>, see section <a href="#st_005ffake">st_fake</a></dt>

38631

<dt> st-likeoxyda-open → <code>st_fake_oxyda, state=OPEN</code>, see section <a href="#st_005ffake">st_fake</a></dt>

38632

<dt> st-likeoxydb → <code>st_fake_oxydb</code>, see section <a href="#st_005ffake">st_fake</a></dt>

38633

<dt> st-likeoxydb-open → <code>st_fake_oxydb, state=OPEN</code>, see section <a href="#st_005ffake">st_fake</a></dt>

38634

<dt> st-likeoxydc → <code>st_fake_oxydc</code>, see section <a href="#st_005ffake">st_fake</a></dt>

38635

<dt> st-likeoxydc-open → <code>st_fake_oxydc, state=OPEN</code>, see section <a href="#st_005ffake">st_fake</a></dt>

38636

<dt> st-likeoxydd → <code>st_fake_oxydd</code>, see section <a href="#st_005ffake">st_fake</a></dt>

38637

<dt> st-likeoxydd-open → <code>st_fake_oxydd, state=OPEN</code>, see section <a href="#st_005ffake">st_fake</a></dt>

38638

<dt> st-mail-e → <code>st_mail_e</code>, see section <a href="#st_005fmail">st_mail</a></dt>

38639

<dt> st-mail-n → <code>st_mail_n</code>, see section <a href="#st_005fmail">st_mail</a></dt>

38640

<dt> st-mail-s → <code>st_mail_s</code>, see section <a href="#st_005fmail">st_mail</a></dt>

38641

<dt> st-mail-w → <code>st_mail_w</code>, see section <a href="#st_005fmail">st_mail</a></dt>

38642

<dt> st-marble → <a href="#st_005fredbrown">st_redbrown</a></dt>

38643

<dt> st-marble_hole → <code>st_redbrown_hollow</code>, see section <a href="#st_005fredbrown">st_redbrown</a></dt>

38644

<dt> st-marble_move → <code>st_redbrown_movable</code>, see section <a href="#st_005fredbrown">st_redbrown</a></dt>

38645

<dt> st-metal → <a href="#st_005fmetal">st_metal</a></dt>

38646

<dt> st-metal_hole → <code>st_metal_hollow</code>, see section <a href="#st_005fmetal">st_metal</a></dt>

38647

<dt> st-mirror-p| → <code>st_mirror_slab_n</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38648

<dt> st-mirror-p/ → <code>st_mirror_slab_e</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38649

<dt> st-mirror-p- → <code>st_mirror_slab_s</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38650

<dt> st-mirror-p\\ → <code>st_mirror_slab_w</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38651

<dt> st-mirror-p|t → <code>st_mirror_slab_nt</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38652

<dt> st-mirror-p/t → <code>st_mirror_slab_et</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38653

<dt> st-mirror-p-t → <code>st_mirror_slab_st</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38654

<dt> st-mirror-p\\t → <code>st_mirror_slab_wt</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38655

<dt> st-mirror-p|m → <code>st_mirror_slab_nm</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38656

<dt> st-mirror-p/m → <code>st_mirror_slab_em</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38657

<dt> st-mirror-p-m → <code>st_mirror_slab_sm</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38658

<dt> st-mirror-p\\m → <code>st_mirror_slab_wm</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38659

<dt> st-mirror-p|tm → <code>st_mirror_slab_ntm</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38660

<dt> st-mirror-p/tm → <code>st_mirror_slab_etm</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38661

<dt> st-mirror-p-tm → <code>st_mirror_slab_stm</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38662

<dt> st-mirror-p\\tm → <code>st_mirror_slab_wtm</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38663

<dt> st-mirror-3^ → <code>st_mirror_triangle_n</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38664

<dt> st-mirror-3> → <code>st_mirror_triangle_e</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38665

<dt> st-mirror-3v → <code>st_mirror_triangle_s</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38666

<dt> st-mirror-3< → <code>st_mirror_triangle_w</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38667

<dt> st-mirror-3^t → <code>st_mirror_triangle_nt</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38668

<dt> st-mirror-3>t → <code>st_mirror_triangle_et</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38669

<dt> st-mirror-3vt → <code>st_mirror_triangle_st</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38670

<dt> st-mirror-3<t → <code>st_mirror_triangle_wt</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38671

<dt> st-mirror-3^m → <code>st_mirror_triangle_nm</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38672

<dt> st-mirror-3>m → <code>st_mirror_triangle_em</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38673

<dt> st-mirror-3vm → <code>st_mirror_triangle_sm</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38674

<dt> st-mirror-3<m → <code>st_mirror_triangle_wm</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38675

<dt> st-mirror-3^tm → <code>st_mirror_triangle_ntm</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38676

<dt> st-mirror-3>tm → <code>st_mirror_triangle_etm</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38677

<dt> st-mirror-3vtm → <code>st_mirror_triangle_stm</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38678

<dt> st-mirror-3<tm → <code>st_mirror_triangle_wtm</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38679

<dt> st-oneway → <a href="#st_005foneway">st_oneway</a></dt>

38680

<dt> st-oneway_black" → <code>st_oneway_black</code>, see section <a href="#st_005foneway">st_oneway</a></dt>

38681

<dt> st-oneway_black-e" → <code>st_oneway_black_e</code>, see section <a href="#st_005foneway">st_oneway</a></dt>

38682

<dt> st-oneway_black-n" → <code>st_oneway_black_n</code>, see section <a href="#st_005foneway">st_oneway</a></dt>

38683

<dt> st-oneway_black-s" → <code>st_oneway_black_s</code>, see section <a href="#st_005foneway">st_oneway</a></dt>

38684

<dt> st-oneway_black-w" → <code>st_oneway_black_w</code>, see section <a href="#st_005foneway">st_oneway</a></dt>

38685

<dt> st-oneway-e" → <code>st_oneway_e</code>, see section <a href="#st_005foneway">st_oneway</a></dt>

38686

<dt> st-oneway-n" → <code>st_oneway_n</code>, see section <a href="#st_005foneway">st_oneway</a></dt>

38687

<dt> st-oneway-s" → <code>st_oneway_s</code>, see section <a href="#st_005foneway">st_oneway</a></dt>

38688

<dt> st-oneway-w" → <code>st_oneway_w</code>, see section <a href="#st_005foneway">st_oneway</a></dt>

38689

<dt> st-oneway_white" → <code>st_oneway_white</code>, see section <a href="#st_005foneway">st_oneway</a></dt>

38690

<dt> st-oneway_white-e" → <code>st_oneway_white_e</code>, see section <a href="#st_005foneway">st_oneway</a></dt>

38691

<dt> st-oneway_white-n" → <code>st_oneway_white_n</code>, see section <a href="#st_005foneway">st_oneway</a></dt>

38692

<dt> st-oneway_white-s" → <code>st_oneway_white_s</code>, see section <a href="#st_005foneway">st_oneway</a></dt>

38693

<dt> st-oneway_white-w" → <code>st_oneway_white_w</code>, see section <a href="#st_005foneway">st_oneway</a></dt>

38694

38695

<dt> st-plain → <a href="#st_005fflat">st_flat</a></dt>

38696

<dt> st-plain_break → <code>st_flat_breakable</code>, see section <a href="#st_005fflat">st_flat</a></dt>

38697

<dt> st-plain_cracked → <code>st_flat_cracked</code>, see section <a href="#st_005fflat">st_flat</a></dt>

38698

<dt> st-plain_hole → <code>st_flat_hollow</code>, see section <a href="#st_005fflat">st_flat</a></dt>

38699

<dt> st-plain_move → <code>st_flat_movable</code>, see section <a href="#st_005fflat">st_flat</a></dt>

38700

<dt> st-pmirror → <code>st_mirror_slab_e</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38701

<dt> st-polarswitch → <a href="#st_005fpolarswitch">st_polarswitch</a></dt>

38702

38703

<dt> st-puzzle → <a href="#st_005fpuzzle">st_puzzle</a></dt>

38704

<dt> st-puzzle-e → <code>st_puzzle_blue_e</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38705

<dt> st-puzzle-es → <code>st_puzzle_blue_es</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38706

<dt> st-puzzle-esw → <code>st_puzzle_blue_esw</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38707

<dt> st-puzzle-ew → <code>st_puzzle_blue_ew</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38708

<dt> st-puzzle-hollow → <code>st_puzzle_blue_nesw_hollow</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38709

<dt> st-puzzle-n → <code>st_puzzle_blue_n</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38710

<dt> st-puzzle-ne → <code>st_puzzle_blue_ne</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38711

<dt> st-puzzle-nes → <code>st_puzzle_blue_nes</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38712

<dt> st-puzzle-nesw → <code>st_puzzle_blue_nesw</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38713

<dt> st-puzzle-new → <code>st_puzzle_blue_new</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38714

<dt> st-puzzle-ns → <code>st_puzzle_blue_ns</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38715

<dt> st-puzzle-nsw → <code>st_puzzle_blue_nsw</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38716

<dt> st-puzzle-nw → <code>st_puzzle_blue_nw</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38717

<dt> st-puzzle-s → <code>st_puzzle_blue_s</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38718

<dt> st-puzzle-sw → <code>st_puzzle_blue_sw</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38719

<dt> st-puzzle-w → <code>st_puzzle_blue_w</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38720

<dt> st-puzzle2-e → <code>st_puzzle_yellow_e</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38721

<dt> st-puzzle2-es → <code>st_puzzle_yellow_es</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38722

<dt> st-puzzle2-esw → <code>st_puzzle_yellow_esw</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38723

<dt> st-puzzle2-ew → <code>st_puzzle_yellow_ew</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38724

<dt> st-puzzle2-hollow → <code>st_puzzle_yellow_nesw_hollow</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38725

<dt> st-puzzle2-n → <code>st_puzzle_yellow_n</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38726

<dt> st-puzzle2-ne → <code>st_puzzle_yellow_ne</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38727

<dt> st-puzzle2-nes → <code>st_puzzle_yellow_nes</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38728

<dt> st-puzzle2-nesw → <code>st_puzzle_yellow_nesw</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38729

<dt> st-puzzle2-new → <code>st_puzzle_yellow_new</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38730

<dt> st-puzzle2-ns → <code>st_puzzle_yellow_ns</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38731

<dt> st-puzzle2-nsw → <code>st_puzzle_yellow_nsw</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38732

<dt> st-puzzle2-nw → <code>st_puzzle_yellow_nw</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38733

<dt> st-puzzle2-s → <code>st_puzzle_yellow_s</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38734

<dt> st-puzzle2-sw → <code>st_puzzle_yellow_sw</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38735

<dt> st-puzzle2-w → <code>st_puzzle_yellow_w</code>, see section <a href="#st_005fpuzzle">st_puzzle</a></dt>

38736

<dt> st-redrock → <a href="#st_005fredrock">st_redrock</a></dt>

38737

<dt> st-rock1 → <a href="#st_005fgranite">st_granite</a></dt>

38738

<dt> st-rock1_hole → <code>st_granite_hollow</code>, see section <a href="#st_005fgranite">st_granite</a></dt>

38739

<dt> st-rock1_move → <code>st_granite_movable</code>, see section <a href="#st_005fgranite">st_granite</a></dt>

38740

<dt> st-rock2 → <a href="#st_005fdarkgray">st_darkgray</a></dt>

38741

<dt> st-rock2_hole → <code>st_darkgray_hollow</code>, see section <a href="#st_005fdarkgray">st_darkgray</a></dt>

38742

<dt> st-rock3 → <a href="#st_005fplaster">st_plaster</a></dt>

38743

<dt> st-rock3_break → <code>st_plaster_breakable</code>, see section <a href="#st_005fplaster">st_plaster</a></dt>

38744

<dt> st-rock3_hole → <code>st_plaster_hollow</code>, see section <a href="#st_005fplaster">st_plaster</a></dt>

38745

<dt> st-rock3_move → <code>st_plaster_movable</code>, see section <a href="#st_005fplaster">st_plaster</a></dt>

38746

<dt> st-rock3_movebreak → <code>st_plaster_movebreakable</code>, see section <a href="#st_005fplaster">st_plaster</a></dt>

38747

<dt> st-rock4 → <a href="#st_005fpurplemarble">st_purplemarble</a></dt>

38748

<dt> st-rock5 → <a href="#st_005ftigris">st_tigris</a></dt>

38749

<dt> st-rock6 → <a href="#st_005fpurplegray">st_purplegray</a></dt>

38750

<dt> st-rock7 → <a href="#st_005fgreengray">st_greengray</a></dt>

38751

<dt> st-rock8 → <a href="#st_005fconcrete">st_concrete</a></dt>

38752

<dt> st-rock9 → <a href="#st_005fancient">st_ancient</a></dt>

38753

<dt> st-rock10 → <a href="#st_005fbrownmarble">st_brownmarble</a></dt>

38754

<dt> st-rotator-left → <code>st_rotator_ccw</code>, see section <a href="#st_005frotator">st_rotator</a></dt>

38755

<dt> st-rotator_move-left → <code>st_rotator_ccw_movable</code>, see section <a href="#st_005frotator">st_rotator</a></dt>

38756

<dt> st-rotator_move-right → <code>st_rotator_cw_movable</code>, see section <a href="#st_005frotator">st_rotator</a></dt>

38757

<dt> st-rotator-right → <code>st_rotator_cw</code>, see section <a href="#st_005frotator">st_rotator</a></dt>

38758

<dt> st-rubberband → <a href="#st_005frubberband">st_rubberband</a></dt>

38759

<dt> st-scissors → <code>st_scissors, inverse=true</code>, see section <a href="#st_005fscissors">st_scissors</a></dt>

38760

<dt> st-shogun → <a href="#st_005fshogun">st_shogun</a></dt>

38761

<dt> st-shogun-l → <code>st_shogun_l</code>, see section <a href="#st_005fshogun">st_shogun</a></dt>

38762

<dt> st-shogun-m → <code>st_shogun_m</code>, see section <a href="#st_005fshogun">st_shogun</a></dt>

38763

<dt> st-shogun-ml → <code>st_shogun_ml</code>, see section <a href="#st_005fshogun">st_shogun</a></dt>

38764

<dt> st-shogun-s → <code>st_shogun_s</code>, see section <a href="#st_005fshogun">st_shogun</a></dt>

38765

<dt> st-shogun-sl → <code>st_shogun_sl</code>, see section <a href="#st_005fshogun">st_shogun</a></dt>

38766

<dt> st-shogun-sm → <code>st_shogun_sm</code>, see section <a href="#st_005fshogun">st_shogun</a></dt>

38767

<dt> st-shogun-sml → <code>st_shogun_sml</code>, see section <a href="#st_005fshogun">st_shogun</a></dt>

38768

<dt> st-spitter → <a href="#st_005fspitter">st_spitter</a></dt>

38769

<dt> st-stonebrush → <code>st_ghost_purplemarble</code>, see section <a href="#st_005fghost">st_ghost</a></dt>

38770

<dt> st-stoneimpulse → <a href="#st_005fstoneimpulse">st_stoneimpulse</a></dt>

38771

<dt> st-stoneimpulse-hollow → <code>st_stoneimpulse_hollow</code>, see section <a href="#st_005fstoneimpulse">st_stoneimpulse</a></dt>

38772

<dt> st-stoneimpulse_movable → <code>st_stoneimpulse_movable</code>, see section <a href="#st_005fstoneimpulse">st_stoneimpulse</a></dt>

38773

<dt> st-stone1 → <a href="#st_005fbrownpyramid">st_brownpyramid</a></dt>

38774

<dt> st-stone2 → <a href="#st_005fredmarble">st_redmarble</a></dt>

38775

<dt> st-stone_break → <code>st_break_oxydc</code>, see section <a href="#st_005fbreak">st_break</a></dt>

38776

<dt> st-surprise → <a href="#st_005fsurprise">st_surprise</a></dt>

38777

38778

<dt> st-switch → <code>st_switch, instant=true</code>, see section <a href="#st_005fswitch">st_switch</a></dt>

38779

<dt> st-switch_black → <code>st_switch_black, instant=true</code>, see section <a href="#st_005fswitch">st_switch</a></dt>

38780

<dt> st-switch_white → <code>st_switch_white, instant=true</code>, see section <a href="#st_005fswitch">st_switch</a></dt>

38781

<dt> st-thief → <a href="#st_005fthief">st_thief</a></dt>

38782

<dt> st-timer → <a href="#st_005ftimer">st_timer</a></dt>

38783

<dt> st-timeswitch → <a href="#st_005fmonoflop">st_monoflop</a></dt>

38784

<dt> st-turnstile → <code>st_turnstile_red</code>, see section <a href="#st_005fturnstile">st_turnstile</a></dt>

38785

<dt> st-turnstile-green → <code>st_turnstile_green</code>, see section <a href="#st_005fturnstile">st_turnstile</a></dt>

38786

<dt> st-turnstile-e → <code>st_turnstilearm_e</code>, see section <a href="#st_005fturnstilearm">st_turnstilearm</a></dt>

38787

<dt> st-turnstile-n → <code>st_turnstilearm_n</code>, see section <a href="#st_005fturnstilearm">st_turnstilearm</a></dt>

38788

<dt> st-turnstile-s → <code>st_turnstilearm_s</code>, see section <a href="#st_005fturnstilearm">st_turnstilearm</a></dt>

38789

<dt> st-turnstile-w → <code>st_turnstilearm_w</code>, see section <a href="#st_005fturnstilearm">st_turnstilearm</a></dt>

38790

<dt> st-volcano → <a href="#st_005fvolcano">st_volcano</a></dt>

38791

<dt> st-volcano_active → <code>st_volcano_active</code>, see section <a href="#st_005fvolcano">st_volcano</a></dt>

38792

<dt> st-volcano-growing → <code>st_volcano_new</code>, see section <a href="#st_005fvolcano">st_volcano</a></dt>

38793

<dt> st-volcano_inactive → <code>st_volcano_idle</code>, see section <a href="#st_005fvolcano">st_volcano</a></dt>

38794

<dt> st-whiteballs → <code>st_jamb_white</code>, see section <a href="#st_005fjamb">st_jamb</a></dt>

38795

<dt> st-white1 → <code>st_passage_white_square</code>, see section <a href="#st_005fpassage">st_passage</a></dt>

38796

<dt> st-white2 → <code>st_passage_white_slash</code>, see section <a href="#st_005fpassage">st_passage</a></dt>

38797

<dt> st-white3 → <code>st_passage_white_cross</code>, see section <a href="#st_005fpassage">st_passage</a></dt>

38798

<dt> st-white4 → <code>st_passage_white_frame</code>, see section <a href="#st_005fpassage">st_passage</a></dt>

38799

<dt> st-window → <a href="#st_005fwindow">st_window</a></dt>

38800

<dt> st-wood → <code>st_box_wood</code>, see section <a href="#st_005fbox">st_box</a></dt>

38801

<dt> st-wood1 → <code>st_box_wood_h</code>, see section <a href="#st_005fbox">st_box</a></dt>

38802

<dt> st-wood2 → <code>st_box_wood_v</code>, see section <a href="#st_005fbox">st_box</a></dt>

38803

<dt> st-wood-growing → <code>st_box_wood_growing</code>, see section <a href="#st_005fbox">st_box</a></dt>

38804

<dt> st-wood_001 → <a href="#st_005fpanel">st_panel</a></dt>

38805

<dt> st-woven → <a href="#st_005fwoven">st_woven</a></dt>

38806

<dt> st-yellow → <a href="#st_005fyellow">st_yellow</a></dt>

38807

<dt> st-yinyang1 → <code>st_blur_cross</code>, see section <a href="#st_005fblur">st_blur</a></dt>

38808

<dt> st-yinyang2 → <code>st_blur_straight</code>, see section <a href="#st_005fblur">st_blur</a></dt>

38809

<dt> st-yinyang3 → <code>st_blur_magic</code>, see section <a href="#st_005fblur">st_blur</a></dt>

38810

<dt> st-3mirror → <code>st_mirror_triangle_s</code>, see section <a href="#st_005fmirror">st_mirror</a></dt>

38811

</dl>

38812

38813

38814

38815

38816

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

38817

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

38818

38819

</tr></table>

38820

<h1>Table of Contents</h1>

38821

38822

38823

38824

<li><a name="toc-Running-Enigma-1" href="#Running-Enigma">1. Running Enigma</a>

38825

38826

<li><a name="toc-Locating-Resources-1" href="#Locating-Resources">1.1 Locating Resources</a></li>

38827

<li><a name="toc-Startup-Switches-1" href="#Startup-Switches">1.2 Startup Switches</a></li>

38828

<li><a name="toc-User-Options-1" href="#User-Options">1.3 User Options</a></li>

38829

<li><a name="toc-Inventory-Console-1" href="#Inventory-Console">1.4 Inventory Console</a></li>

38830

<li><a name="toc-Level-Info-1" href="#Level-Info">1.5 Level Info</a>

38831

38832

<li><a name="toc-Public-Ratings-1" href="#Public-Ratings">1.5.1 Public Ratings</a></li>

38833

<li><a name="toc-Scores-1" href="#Scores">1.5.2 Scores</a></li>

38834

<li><a name="toc-Versions-1" href="#Versions">1.5.3 Versions</a></li>

38835

<li><a name="toc-Private-Annotations-and-Ratings-1" href="#Private-Annotations-and-Ratings">1.5.4 Private Annotations and Ratings</a></li>

38836

<li><a name="toc-Screenshots-1" href="#Screenshots">1.5.5 Screenshots</a></li>

38837

</ul></li>

38838

<li><a name="toc-Handicap-and-PAR-1" href="#Handicap-and-PAR">1.6 Handicap and PAR</a></li>

38839

<li><a name="toc-User-Sound-Sets-1" href="#User-Sound-Sets">1.7 User Sound Sets</a></li>

38840

</ul></li>

38841

<li><a name="toc-Levelpack-Basics-1" href="#Levelpack-Basics">2. Levelpack Basics</a>

38842

38843

<li><a name="toc-Getting-Started-with-Levelpacks-1" href="#Getting-Started-with-Levelpacks">2.1 Getting Started with Levelpacks</a></li>

38844

<li><a name="toc-Converting-0_002e92-Levelpacks-1" href="#Converting-0_002e92-Levelpacks">2.2 Converting 0.92 Levelpacks</a></li>

38845

<li><a name="toc-Zip-Levelpacks-1" href="#Zip-Levelpacks">2.3 Zip Levelpacks</a></li>

38846

<li><a name="toc-Grouping-and-Sorting-Levelpacks-1" href="#Grouping-and-Sorting-Levelpacks">2.4 Grouping and Sorting Levelpacks</a></li>

38847

<li><a name="toc-Creating-New-Levelpacks-1" href="#Creating-New-Levelpacks">2.5 Creating New Levelpacks</a></li>

38848

<li><a name="toc-Modifying-and-Deleting-Levelpacks-1" href="#Modifying-and-Deleting-Levelpacks">2.6 Modifying and Deleting Levelpacks</a></li>

38849

<li><a name="toc-Composing-Levelpacks-1" href="#Composing-Levelpacks">2.7 Composing Levelpacks</a></li>

38850

</ul></li>

38851

<li><a name="toc-Level-Basics-1" href="#Level-Basics">3. Level Basics</a>

38852

38853

<li><a name="toc-Getting-Started-with-Levels-1" href="#Getting-Started-with-Levels">3.1 Getting Started with Levels</a></li>

38854

<li><a name="toc-XML-Level-structure-1" href="#XML-Level-structure">3.2 XML Level structure</a></li>

38855

<li><a name="toc-Info-metadata-1" href="#Info-metadata">3.3 Info metadata</a>

38856

38857

38858

38859

38860

38861

38862

38863

38864

38865

38866

</ul></li>

38867

38868

<li><a name="toc-Internationalization-_0028i18n_0029-1" href="#Internationalization-_0028i18n_0029">3.5 Internationalization (i18n)</a></li>

38869

<li><a name="toc-Usage-1" href="#Usage">3.6 Usage</a></li>

38870

<li><a name="toc-Update-and-Upgrade-1" href="#Update-and-Upgrade">3.7 Update and Upgrade</a></li>

38871

<li><a name="toc-Library-Files-1" href="#Library-Files">3.8 Library Files</a>

38872

38873

<li><a name="toc-Writing-a-Library-1" href="#Writing-a-Library">3.8.1 Writing a Library</a></li>

38874

<li><a name="toc-Maintaining-a-Library-1" href="#Maintaining-a-Library">3.8.2 Maintaining a Library</a></li>

38875

</ul></li>

38876

<li><a name="toc-Multilevel-Files-1" href="#Multilevel-Files">3.9 Multilevel Files</a></li>

38877

</ul></li>

38878

<li><a name="toc-Enigma-Paradigm-1" href="#Enigma-Paradigm">4. Enigma Paradigm</a>

38879

38880

<li><a name="toc-The-World_0027s-Structure-1" href="#The-World_0027s-Structure">4.1 The World’s Structure</a>

38881

38882

<li><a name="toc-World_0027s-Shape-and-Coordinates-1" href="#World_0027s-Shape-and-Coordinates">4.1.1 World’s Shape and Coordinates</a></li>

38883

<li><a name="toc-Object-Layers-1" href="#Object-Layers">4.1.2 Object Layers</a></li>

38884

<li><a name="toc-World-as-an-Object-1" href="#World-as-an-Object">4.1.3 World as an Object</a></li>

38885

<li><a name="toc-Unpositioned-Objects-1" href="#Unpositioned-Objects">4.1.4 Unpositioned Objects</a></li>

38886

<li><a name="toc-Player-and-Inventory-1" href="#Player-and-Inventory">4.1.5 Player and Inventory</a></li>

38887

<li><a name="toc-Owned-Objects-1" href="#Owned-Objects">4.1.6 Owned Objects</a></li>

38888

</ul></li>

38889

<li><a name="toc-Object-Description-1" href="#Object-Description">4.2 Object Description</a>

38890

38891

<li><a name="toc-Object-Kind-1" href="#Object-Kind">4.2.1 Object Kind</a></li>

38892

<li><a name="toc-Object-Reference-1" href="#Object-Reference">4.2.2 Object Reference</a></li>

38893

<li><a name="toc-Object-Naming-1" href="#Object-Naming">4.2.3 Object Naming</a></li>

38894

<li><a name="toc-Object-Attributes-1" href="#Object-Attributes">4.2.4 Object Attributes</a></li>

38895

</ul></li>

38896

<li><a name="toc-Methods-of-Interaction-1" href="#Methods-of-Interaction">4.3 Methods of Interaction</a>

38897

38898

<li><a name="toc-Messages-1" href="#Messages">4.3.1 Messages</a></li>

38899

<li><a name="toc-Target-_002d-Action-1" href="#Target-_002d-Action">4.3.2 Target - Action</a></li>

38900

<li><a name="toc-Callback-Function-1" href="#Callback-Function">4.3.3 Callback Function</a></li>

38901

<li><a name="toc-Object-State-1" href="#Object-State">4.3.4 Object State</a></li>

38902

</ul></li>

38903

<li><a name="toc-The-Lifecycle-of-a-Level-1" href="#The-Lifecycle-of-a-Level">4.4 The Lifecycle of a Level</a>

38904

38905

<li><a name="toc-Library-Preloading-1" href="#Library-Preloading">4.4.1 Library Preloading</a></li>

38906

<li><a name="toc-Snapshot-Principle-1" href="#Snapshot-Principle">4.4.2 Snapshot Principle</a></li>

38907

<li><a name="toc-Level-Initialization-1" href="#Level-Initialization">4.4.3 Level Initialization</a></li>

38908

<li><a name="toc-Object-Transformation-1" href="#Object-Transformation">4.4.4 Object Transformation</a></li>

38909

<li><a name="toc-Named-Positions-1" href="#Named-Positions">4.4.5 Named Positions</a></li>

38910

<li><a name="toc-Callbacks-and-Load-Balancing-1" href="#Callbacks-and-Load-Balancing">4.4.6 Callbacks and Load Balancing</a></li>

38911

<li><a name="toc-Level-Restart-1" href="#Level-Restart">4.4.7 Level Restart</a></li>

38912

<li><a name="toc-Ending-Conditions-1" href="#Ending-Conditions">4.4.8 Ending Conditions</a></li>

38913

</ul>

38914

</li>

38915

</ul></li>

38916

38917

38918

<li><a name="toc-Basic-Lua-Examples-1" href="#Basic-Lua-Examples">5.1 Basic Lua Examples</a>

38919

38920

<li><a name="toc-Basic-Example-1" href="#Basic-Example">5.1.1 Basic Example</a></li>

38921

<li><a name="toc-Colored-Turnstiles-1" href="#Colored-Turnstiles">5.1.2 Colored Turnstiles</a></li>

38922

</ul></li>

38923

<li><a name="toc-API-2-Overview-1" href="#API-2-Overview">5.2 API 2 Overview</a>

38924

38925

<li><a name="toc-Types-Overview-1" href="#Types-Overview">5.2.1 Types Overview</a></li>

38926

<li><a name="toc-Position-Tasks-1" href="#Position-Tasks">5.2.2 Position Tasks</a></li>

38927

<li><a name="toc-Attribute-Tasks-1" href="#Attribute-Tasks">5.2.3 Attribute Tasks</a></li>

38928

<li><a name="toc-Object-Tasks-1" href="#Object-Tasks">5.2.4 Object Tasks</a></li>

38929

<li><a name="toc-Group-Tasks-1" href="#Group-Tasks">5.2.5 Group Tasks</a></li>

38930

<li><a name="toc-Tiles-and-World-Tasks-1" href="#Tiles-and-World-Tasks">5.2.6 Tiles and World Tasks</a></li>

38931

<li><a name="toc-Named-Positions-Tasks-1" href="#Named-Positions-Tasks">5.2.7 Named Positions Tasks</a></li>

38932

</ul></li>

38933

<li><a name="toc-Advanced-Lua-Examples-1" href="#Advanced-Lua-Examples">5.3 Advanced Lua Examples</a>

38934

38935

<li><a name="toc-Color-Maze-1" href="#Color-Maze">5.3.1 Color Maze</a></li>

38936

<li><a name="toc-Weirdly-Wired-1" href="#Weirdly-Wired">5.3.2 Weirdly Wired</a></li>

38937

</ul></li>

38938

<li><a name="toc-Introduction-to-Datatypes-1" href="#Introduction-to-Datatypes">5.4 Introduction to Datatypes</a>

38939

38940

<li><a name="toc-Syntax-and-Conventions-1" href="#Syntax-and-Conventions">5.4.1 Syntax and Conventions</a></li>

38941

<li><a name="toc-Value-and-Reference-1" href="#Value-and-Reference">5.4.2 Value and Reference</a></li>

38942

<li><a name="toc-Polymorphism-and-Overloading-1" href="#Polymorphism-and-Overloading">5.4.3 Polymorphism and Overloading</a></li>

38943

<li><a name="toc-Pseudo-Datatypes-1" href="#Pseudo-Datatypes">5.4.4 Pseudo Datatypes</a></li>

38944

</ul></li>

38945

<li><a name="toc-Position-1" href="#Position">5.5 Position</a>

38946

38947

<li><a name="toc-Position-Addition-and-Subtraction-1" href="#Position-Addition-and-Subtraction">5.5.1 Position Addition and Subtraction</a></li>

38948

<li><a name="toc-Position-Multiplication-and-Division-1" href="#Position-Multiplication-and-Division">5.5.2 Position Multiplication and Division</a></li>

38949

<li><a name="toc-Position-Sign-1" href="#Position-Sign">5.5.3 Position Sign</a></li>

38950

<li><a name="toc-Position-Center-1" href="#Position-Center">5.5.4 Position Center</a></li>

38951

<li><a name="toc-Position-Comparison-1" href="#Position-Comparison">5.5.5 Position Comparison</a></li>

38952

<li><a name="toc-Position-Concatenation-1" href="#Position-Concatenation">5.5.6 Position Concatenation</a></li>

38953

<li><a name="toc-Position-Coordinate-Access-1" href="#Position-Coordinate-Access">5.5.7 Position Coordinate Access</a></li>

38954

<li><a name="toc-Position-Grid-Rounding-1" href="#Position-Grid-Rounding">5.5.8 Position Grid Rounding</a></li>

38955

<li><a name="toc-Position-Existence-1" href="#Position-Existence">5.5.9 Position Existence</a></li>

38956

</ul></li>

38957

<li><a name="toc-Object-1" href="#Object">5.6 Object</a>

38958

38959

<li><a name="toc-Object-Attribute-Access-1" href="#Object-Attribute-Access">5.6.1 Object Attribute Access</a></li>

38960

<li><a name="toc-Object-Messaging-1" href="#Object-Messaging">5.6.2 Object Messaging</a></li>

38961

<li><a name="toc-Object-Comparison-1" href="#Object-Comparison">5.6.3 Object Comparison</a></li>

38962

<li><a name="toc-Object-Existence-1" href="#Object-Existence">5.6.4 Object Existence</a></li>

38963

<li><a name="toc-Object-Kill-1" href="#Object-Kill">5.6.5 Object Kill</a></li>

38964

<li><a name="toc-Object-Kind-Check-1" href="#Object-Kind-Check">5.6.6 Object Kind Check</a></li>

38965

<li><a name="toc-Object-Coordinate-Access-1" href="#Object-Coordinate-Access">5.6.7 Object Coordinate Access</a></li>

38966

<li><a name="toc-Object-Addition-and-Subtraction-1" href="#Object-Addition-and-Subtraction">5.6.8 Object Addition and Subtraction</a></li>

38967

<li><a name="toc-Object-Center-1" href="#Object-Center">5.6.9 Object Center</a></li>

38968

<li><a name="toc-Object-Join-1" href="#Object-Join">5.6.10 Object Join</a></li>

38969

<li><a name="toc-Object-Intersection-1" href="#Object-Intersection">5.6.11 Object Intersection</a></li>

38970

<li><a name="toc-Object-Difference-1" href="#Object-Difference">5.6.12 Object Difference</a></li>

38971

<li><a name="toc-Object-Sound-1" href="#Object-Sound">5.6.13 Object Sound</a></li>

38972

</ul></li>

38973

<li><a name="toc-Group-1" href="#Group">5.7 Group</a>

38974

38975

<li><a name="toc-Group-Messaging-1" href="#Group-Messaging">5.7.1 Group Messaging</a></li>

38976

<li><a name="toc-Group-Attribute-Write-1" href="#Group-Attribute-Write">5.7.2 Group Attribute Write</a></li>

38977

<li><a name="toc-Group-Comparison-1" href="#Group-Comparison">5.7.3 Group Comparison</a></li>

38978

<li><a name="toc-Group-Length-1" href="#Group-Length">5.7.4 Group Length</a></li>

38979

<li><a name="toc-Group-Member-Access-1" href="#Group-Member-Access">5.7.5 Group Member Access</a></li>

38980

<li><a name="toc-Group-Loop-1" href="#Group-Loop">5.7.6 Group Loop</a></li>

38981

<li><a name="toc-Group-Join-1" href="#Group-Join">5.7.7 Group Join</a></li>

38982

<li><a name="toc-Group-Intersection-1" href="#Group-Intersection">5.7.8 Group Intersection</a></li>

38983

<li><a name="toc-Group-Difference-1" href="#Group-Difference">5.7.9 Group Difference</a></li>

38984

<li><a name="toc-Group-Shuffle-1" href="#Group-Shuffle">5.7.10 Group Shuffle</a></li>

38985

<li><a name="toc-Group-Sorting-1" href="#Group-Sorting">5.7.11 Group Sorting</a></li>

38986

<li><a name="toc-Group-Subset-1" href="#Group-Subset">5.7.12 Group Subset</a></li>

38987

<li><a name="toc-Group-Nearest-Object-1" href="#Group-Nearest-Object">5.7.13 Group Nearest Object</a></li>

38988

</ul></li>

38989

<li><a name="toc-NamedObjects-1" href="#NamedObjects">5.8 NamedObjects</a>

38990

38991

<li><a name="toc-NamedObjects-Repository-Request-1" href="#NamedObjects-Repository-Request">5.8.1 NamedObjects Repository Request</a></li>

38992

<li><a name="toc-NamedObjects-Object-Naming-1" href="#NamedObjects-Object-Naming">5.8.2 NamedObjects Object Naming</a></li>

38993

</ul></li>

38994

<li><a name="toc-PositionList-1" href="#PositionList">5.9 PositionList</a>

38995

38996

<li><a name="toc-PositionList-Comparison-1" href="#PositionList-Comparison">5.9.1 PositionList Comparison</a></li>

38997

<li><a name="toc-PositionList-Length-1" href="#PositionList-Length">5.9.2 PositionList Length</a></li>

38998

<li><a name="toc-PositionList-Member-Access-1" href="#PositionList-Member-Access">5.9.3 PositionList Member Access</a></li>

38999

<li><a name="toc-PositionList-Concatenation-1" href="#PositionList-Concatenation">5.9.4 PositionList Concatenation</a></li>

39000

<li><a name="toc-PositionList-Translation-1" href="#PositionList-Translation">5.9.5 PositionList Translation</a></li>

39001

<li><a name="toc-PositionList-Stretching-1" href="#PositionList-Stretching">5.9.6 PositionList Stretching</a></li>

39002

</ul></li>

39003

<li><a name="toc-Positions-Repository-1" href="#Positions-Repository">5.10 Positions Repository</a>

39004

39005

<li><a name="toc-Positions-Repository-Request-1" href="#Positions-Repository-Request">5.10.1 Positions Repository Request</a></li>

39006

<li><a name="toc-Positions-Repository-Storage-1" href="#Positions-Repository-Storage">5.10.2 Positions Repository Storage</a></li>

39007

<li><a name="toc-Position-Conversion-1" href="#Position-Conversion">5.10.3 Position Conversion</a></li>

39008

<li><a name="toc-PositionList-Conversion-1" href="#PositionList-Conversion">5.10.4 PositionList Conversion</a></li>

39009

</ul></li>

39010

<li><a name="toc-Tile-and-Object-Declaration-1" href="#Tile-and-Object-Declaration">5.11 Tile and Object Declaration</a>

39011

39012

<li><a name="toc-Tile-concat-1" href="#Tile-concat">5.11.1 Tile concat</a></li>

39013

</ul></li>

39014

<li><a name="toc-Tiles-Repository-1" href="#Tiles-Repository">5.12 Tiles Repository</a>

39015

39016

<li><a name="toc-Tiles-Storage-1" href="#Tiles-Storage">5.12.1 Tiles Storage</a></li>

39017

<li><a name="toc-Tiles-Request-1" href="#Tiles-Request">5.12.2 Tiles Request</a></li>

39018

<li><a name="toc-Tile-Conversion-1" href="#Tile-Conversion">5.12.3 Tile Conversion</a></li>

39019

</ul></li>

39020

<li><a name="toc-World-1" href="#World">5.13 World</a>

39021

39022

<li><a name="toc-World-Creation-1" href="#World-Creation">5.13.1 World Creation</a></li>

39023

<li><a name="toc-World-Tile-Set-1" href="#World-Tile-Set">5.13.2 World Tile Set</a></li>

39024

<li><a name="toc-Global-Attribute-Set-1" href="#Global-Attribute-Set">5.13.3 Global Attribute Set</a></li>

39025

<li><a name="toc-Global-Attribute-Get-1" href="#Global-Attribute-Get">5.13.4 Global Attribute Get</a></li>

39026

39027

<li><a name="toc-drawBorder-1" href="#drawBorder">5.13.6 drawBorder</a></li>

39028

<li><a name="toc-drawMap-1" href="#drawMap">5.13.7 drawMap</a></li>

39029

<li><a name="toc-drawRect-1" href="#drawRect">5.13.8 drawRect</a></li>

39030

<li><a name="toc-world-floor-1" href="#world-floor">5.13.9 world floor</a></li>

39031

<li><a name="toc-world-item-1" href="#world-item">5.13.10 world item</a></li>

39032

<li><a name="toc-shuffleOxyd-1" href="#shuffleOxyd">5.13.11 shuffleOxyd</a></li>

39033

<li><a name="toc-world-stone-1" href="#world-stone">5.13.12 world stone</a></li>

39034

</ul></li>

39035

<li><a name="toc-Functions-1" href="#Functions">5.14 Functions</a>

39036

39037

<li><a name="toc-assert_005fbool-1" href="#assert_005fbool">5.14.1 assert_bool</a></li>

39038

<li><a name="toc-assert_005ftype-1" href="#assert_005ftype">5.14.2 assert_type</a></li>

39039

39040

<li><a name="toc-etype-1" href="#etype">5.14.4 etype</a></li>

39041

39042

39043

39044

39045

<li><a name="toc-random-1" href="#random">5.14.9 random</a></li>

39046

39047

<li><a name="toc-usertype-1" href="#usertype">5.14.11 usertype</a></li>

39048

</ul>

39049

</li>

39050

</ul></li>

39051

<li><a name="toc-Common-Attributes-and-Messages-1" href="#Common-Attributes-and-Messages">6. Common Attributes and Messages</a>

39052

39053

<li><a name="toc-Common-Attributes-1" href="#Common-Attributes">6.1 Common Attributes</a>

39054

39055

39056

<li><a name="toc-state-1" href="#state">6.1.2 state</a></li>

39057

<li><a name="toc-target-1" href="#target">6.1.3 target</a></li>

39058

<li><a name="toc-action-1" href="#action">6.1.4 action</a></li>

39059

<li><a name="toc-nopaction-1" href="#nopaction">6.1.5 nopaction</a></li>

39060

<li><a name="toc-safeaction-1" href="#safeaction">6.1.6 safeaction</a></li>

39061

<li><a name="toc-inverse-1" href="#inverse">6.1.7 inverse</a></li>

39062

<li><a name="toc-destination-1" href="#destination">6.1.8 destination</a></li>

39063

<li><a name="toc-friction-1" href="#friction">6.1.9 friction</a></li>

39064

<li><a name="toc-adhesion-1" href="#adhesion">6.1.10 adhesion</a></li>

39065

<li><a name="toc-checkerboard-1" href="#checkerboard">6.1.11 checkerboard</a></li>

39066

<li><a name="toc-rubbers-1" href="#rubbers">6.1.12 rubbers</a></li>

39067

<li><a name="toc-wires-1" href="#wires">6.1.13 wires</a></li>

39068

<li><a name="toc-fellows-1" href="#fellows">6.1.14 fellows</a></li>

39069

</ul></li>

39070

<li><a name="toc-Common-Messages-1" href="#Common-Messages">6.2 Common Messages</a>

39071

39072

<li><a name="toc-toggle-1" href="#toggle">6.2.1 toggle</a></li>

39073

39074

<li><a name="toc-signal-1" href="#signal">6.2.3 signal</a></li>

39075

39076

39077

39078

<li><a name="toc-close-1" href="#close">6.2.7 close</a></li>

39079

<li><a name="toc-ignite-1" href="#ignite">6.2.8 ignite</a></li>

39080

39081

<li><a name="toc-setfire-1" href="#setfire">6.2.10 setfire</a></li>

39082

39083

<li><a name="toc-sound-1" href="#sound">6.2.12 sound</a></li>

39084

<li><a name="toc-disconnect-1" href="#disconnect">6.2.13 disconnect</a></li>

39085

</ul></li>

39086

<li><a name="toc-Common-Constants-1" href="#Common-Constants">6.3 Common Constants</a>

39087

39088

<li><a name="toc-state-values-1" href="#state-values">6.3.1 state values</a></li>

39089

<li><a name="toc-color-values-1" href="#color-values">6.3.2 color values</a></li>

39090

<li><a name="toc-actor-controllers-1" href="#actor-controllers">6.3.3 actor controllers</a></li>

39091

<li><a name="toc-oxyd-colors-1" href="#oxyd-colors">6.3.4 oxyd colors</a></li>

39092

<li><a name="toc-orientations-1" href="#orientations">6.3.5 orientations</a></li>

39093

<li><a name="toc-direction-offsets-1" href="#direction-offsets">6.3.6 direction offsets</a></li>

39094

<li><a name="toc-position-lists-1" href="#position-lists">6.3.7 position lists</a></li>

39095

<li><a name="toc-essentialness-1" href="#essentialness">6.3.8 essentialness</a></li>

39096

<li><a name="toc-meditation-types-1" href="#meditation-types">6.3.9 meditation types</a></li>

39097

<li><a name="toc-glasses-abilities-1" href="#glasses-abilities">6.3.10 glasses abilities</a></li>

39098

<li><a name="toc-coinslot-acceptance-1" href="#coinslot-acceptance">6.3.11 coinslot acceptance</a></li>

39099

<li><a name="toc-rubberband-length-1" href="#rubberband-length">6.3.12 rubberband length</a></li>

39100

<li><a name="toc-subsoil-kind-1" href="#subsoil-kind">6.3.13 subsoil kind</a></li>

39101

<li><a name="toc-screen-scrolling-1" href="#screen-scrolling">6.3.14 screen scrolling</a></li>

39102

<li><a name="toc-map-read-directions-1" href="#map-read-directions">6.3.15 map read directions</a></li>

39103

</ul></li>

39104

<li><a name="toc-Global-Attributes-1" href="#Global-Attributes">6.4 Global Attributes</a>

39105

39106

<li><a name="toc-ActorimpulseStrength-1" href="#ActorimpulseStrength">6.4.1 ActorimpulseStrength</a></li>

39107

<li><a name="toc-AllowSingleOxyds-1" href="#AllowSingleOxyds">6.4.2 AllowSingleOxyds</a></li>

39108

<li><a name="toc-AllowSuicide-1" href="#AllowSuicide">6.4.3 AllowSuicide</a></li>

39109

<li><a name="toc-AutoRespawn-1" href="#AutoRespawn">6.4.4 AutoRespawn</a></li>

39110

<li><a name="toc-ConserveLevel-1" href="#ConserveLevel">6.4.5 ConserveLevel</a></li>

39111

<li><a name="toc-CrackSpreading-1" href="#CrackSpreading">6.4.6 CrackSpreading</a></li>

39112

<li><a name="toc-CreatingPreview-1" href="#CreatingPreview">6.4.7 CreatingPreview</a></li>

39113

<li><a name="toc-ElectricStrength-1" href="#ElectricStrength">6.4.8 ElectricStrength</a></li>

39114

<li><a name="toc-ExtralifeGlasses-1" href="#ExtralifeGlasses">6.4.9 ExtralifeGlasses</a></li>

39115

<li><a name="toc-FallenPuzzle-1" href="#FallenPuzzle">6.4.10 FallenPuzzle</a></li>

39116

<li><a name="toc-FollowAction-1" href="#FollowAction">6.4.11 FollowAction</a></li>

39117

<li><a name="toc-FollowGrid-1" href="#FollowGrid">6.4.12 FollowGrid</a></li>

39118

<li><a name="toc-FollowMethod-1" href="#FollowMethod">6.4.13 FollowMethod</a></li>

39119

<li><a name="toc-FollowThreshold-1" href="#FollowThreshold">6.4.14 FollowThreshold</a></li>

39120

<li><a name="toc-Fragility-1" href="#Fragility">6.4.15 Fragility</a></li>

39121

<li><a name="toc-FrictionStrength-1" href="#FrictionStrength">6.4.16 FrictionStrength</a></li>

39122

<li><a name="toc-GlobalForce-1" href="#GlobalForce">6.4.17 GlobalForce</a></li>

39123

<li><a name="toc-Height-1" href="#Height">6.4.18 Height</a></li>

39124

<li><a name="toc-InfiniteReincarnation-1" href="#InfiniteReincarnation">6.4.19 InfiniteReincarnation</a></li>

39125

<li><a name="toc-IsDifficult-1" href="#IsDifficult">6.4.20 IsDifficult</a></li>

39126

<li><a name="toc-MagnetRange-1" href="#MagnetRange">6.4.21 MagnetRange</a></li>

39127

<li><a name="toc-MagnetStrength-1" href="#MagnetStrength">6.4.22 MagnetStrength</a></li>

39128

<li><a name="toc-MaxOxydColor-1" href="#MaxOxydColor">6.4.23 MaxOxydColor</a></li>

39129

<li><a name="toc-MeditationStrength-1" href="#MeditationStrength">6.4.24 MeditationStrength</a></li>

39130

<li><a name="toc-ProvideExtralifes-1" href="#ProvideExtralifes">6.4.25 ProvideExtralifes</a></li>

39131

<li><a name="toc-RubberViolationStrength-1" href="#RubberViolationStrength">6.4.26 RubberViolationStrength</a></li>

39132

<li><a name="toc-ShowMoves-1" href="#ShowMoves">6.4.27 ShowMoves</a></li>

39133

<li><a name="toc-SlopeStrength-1" href="#SlopeStrength">6.4.28 SlopeStrength</a></li>

39134

<li><a name="toc-SublevelNumber-1" href="#SublevelNumber">6.4.29 SublevelNumber</a></li>

39135

<li><a name="toc-SublevelTitle-1" href="#SublevelTitle">6.4.30 SublevelTitle</a></li>

39136

<li><a name="toc-SubSoil-1" href="#SubSoil">6.4.31 SubSoil</a></li>

39137

<li><a name="toc-SurviveFinish-1" href="#SurviveFinish">6.4.32 SurviveFinish</a></li>

39138

<li><a name="toc-SwampSinkTime-1" href="#SwampSinkTime">6.4.33 SwampSinkTime</a></li>

39139

<li><a name="toc-WaterSinkTime-1" href="#WaterSinkTime">6.4.34 WaterSinkTime</a></li>

39140

<li><a name="toc-Width-1" href="#Width">6.4.35 Width</a></li>

39141

<li><a name="toc-WormholeRange-1" href="#WormholeRange">6.4.36 WormholeRange</a></li>

39142

<li><a name="toc-WormholeStrength-1" href="#WormholeStrength">6.4.37 WormholeStrength</a></li>

39143

</ul>

39144

</li>

39145

</ul></li>

39146

<li><a name="toc-Floor-Objects-1" href="#Floor-Objects">7. Floor Objects</a>

39147

39148

<li><a name="toc-Floor-Overview-1" href="#Floor-Overview">7.1 Floor Overview</a></li>

39149

<li><a name="toc-Floor-Attributes-1" href="#Floor-Attributes">7.2 Floor Attributes</a>

39150

39151

<li><a name="toc-adhesion-_0028floor_0029-1" href="#adhesion-_0028floor_0029">7.2.1 adhesion (floor)</a></li>

39152

<li><a name="toc-burnable-1" href="#burnable">7.2.2 burnable</a></li>

39153

<li><a name="toc-eternal-1" href="#eternal">7.2.3 eternal</a></li>

39154

<li><a name="toc-faces-_0028floor_0029-1" href="#faces-_0028floor_0029">7.2.4 faces (floor)</a></li>

39155

<li><a name="toc-fastfire-1" href="#fastfire">7.2.5 fastfire</a></li>

39156

<li><a name="toc-floodable-1" href="#floodable">7.2.6 floodable</a></li>

39157

<li><a name="toc-force_005fx-1" href="#force_005fx">7.2.7 force_x</a></li>

39158

<li><a name="toc-force_005fy-1" href="#force_005fy">7.2.8 force_y</a></li>

39159

<li><a name="toc-fragility-_0028floor_0029-1" href="#fragility-_0028floor_0029">7.2.9 fragility (floor)</a></li>

39160

<li><a name="toc-freeze_005fcheck-_0028floor_0029-1" href="#freeze_005fcheck-_0028floor_0029">7.2.10 freeze_check (floor)</a></li>

39161

<li><a name="toc-friction-_0028floor_0029-1" href="#friction-_0028floor_0029">7.2.11 friction (floor)</a></li>

39162

<li><a name="toc-ignitable-1" href="#ignitable">7.2.12 ignitable</a></li>

39163

<li><a name="toc-indestructible-1" href="#indestructible">7.2.13 indestructible</a></li>

39164

<li><a name="toc-initfire-1" href="#initfire">7.2.14 initfire</a></li>

39165

<li><a name="toc-noash-1" href="#noash">7.2.15 noash</a></li>

39166

<li><a name="toc-push_005fdirections-1" href="#push_005fdirections">7.2.16 push_directions</a></li>

39167

<li><a name="toc-secure-1" href="#secure">7.2.17 secure</a></li>

39168

<li><a name="toc-texture-1" href="#texture">7.2.18 texture</a></li>

39169

</ul></li>

39170

<li><a name="toc-Standard-Floors-1" href="#Standard-Floors">7.3 Standard Floors</a>

39171

39172

<li><a name="toc-fl_005fadhesionless-1" href="#fl_005fadhesionless">7.3.1 fl_adhesionless</a></li>

39173

<li><a name="toc-fl_005faquamarine-1" href="#fl_005faquamarine">7.3.2 fl_aquamarine</a></li>

39174

39175

<li><a name="toc-fl_005fbluegray-1" href="#fl_005fbluegray">7.3.4 fl_bluegray</a></li>

39176

<li><a name="toc-fl_005fbluegreen-1" href="#fl_005fbluegreen">7.3.5 fl_bluegreen</a></li>

39177

<li><a name="toc-fl_005fblueslab-1" href="#fl_005fblueslab">7.3.6 fl_blueslab</a></li>

39178

<li><a name="toc-fl_005fbrick-1" href="#fl_005fbrick">7.3.7 fl_brick</a></li>

39179

<li><a name="toc-fl_005fbright-1" href="#fl_005fbright">7.3.8 fl_bright</a></li>

39180

<li><a name="toc-fl_005fconcrete-1" href="#fl_005fconcrete">7.3.9 fl_concrete</a></li>

39181

39182

<li><a name="toc-fl_005fdarkgray-1" href="#fl_005fdarkgray">7.3.11 fl_darkgray</a></li>

39183

<li><a name="toc-fl_005fdunes-1" href="#fl_005fdunes">7.3.12 fl_dunes</a></li>

39184

<li><a name="toc-fl_005fgravel-1" href="#fl_005fgravel">7.3.13 fl_gravel</a></li>

39185

39186

<li><a name="toc-fl_005fhimalaya-1" href="#fl_005fhimalaya">7.3.15 fl_himalaya</a></li>

39187

<li><a name="toc-fl_005fivory-1" href="#fl_005fivory">7.3.16 fl_ivory</a></li>

39188

39189

<li><a name="toc-fl_005fmarble-1" href="#fl_005fmarble">7.3.18 fl_marble</a></li>

39190

<li><a name="toc-fl_005fmetal-1" href="#fl_005fmetal">7.3.19 fl_metal</a></li>

39191

<li><a name="toc-fl_005fmortar-1" href="#fl_005fmortar">7.3.20 fl_mortar</a></li>

39192

<li><a name="toc-fl_005fpinkbumps-1" href="#fl_005fpinkbumps">7.3.21 fl_pinkbumps</a></li>

39193

<li><a name="toc-fl_005fplank-1" href="#fl_005fplank">7.3.22 fl_plank</a></li>

39194

<li><a name="toc-fl_005fplatinum-1" href="#fl_005fplatinum">7.3.23 fl_platinum</a></li>

39195

39196

<li><a name="toc-fl_005fredslab-1" href="#fl_005fredslab">7.3.25 fl_redslab</a></li>

39197

<li><a name="toc-fl_005frough-1" href="#fl_005frough">7.3.26 fl_rough</a></li>

39198

<li><a name="toc-fl_005fsahara-1" href="#fl_005fsahara">7.3.27 fl_sahara</a></li>

39199

<li><a name="toc-fl_005fsamba-1" href="#fl_005fsamba">7.3.28 fl_samba</a></li>

39200

39201

<li><a name="toc-fl_005fspace-1" href="#fl_005fspace">7.3.30 fl_space</a></li>

39202

<li><a name="toc-fl_005fstone-1" href="#fl_005fstone">7.3.31 fl_stone</a></li>

39203

<li><a name="toc-fl_005ftigris-1" href="#fl_005ftigris">7.3.32 fl_tigris</a></li>

39204

<li><a name="toc-fl_005fwhite-1" href="#fl_005fwhite">7.3.33 fl_white</a></li>

39205

<li><a name="toc-fl_005fwoven-1" href="#fl_005fwoven">7.3.34 fl_woven</a></li>

39206

</ul></li>

39207

<li><a name="toc-Special-Floors-1" href="#Special-Floors">7.4 Special Floors</a>

39208

39209

<li><a name="toc-fl_005fabyss-1" href="#fl_005fabyss">7.4.1 fl_abyss</a></li>

39210

<li><a name="toc-fl_005fbridge-1" href="#fl_005fbridge">7.4.2 fl_bridge</a></li>

39211

39212

39213

39214

<li><a name="toc-fl_005finverse-1" href="#fl_005finverse">7.4.6 fl_inverse</a></li>

39215

39216

<li><a name="toc-fl_005fscales-1" href="#fl_005fscales">7.4.8 fl_scales</a></li>

39217

<li><a name="toc-fl_005fslope-1" href="#fl_005fslope">7.4.9 fl_slope</a></li>

39218

<li><a name="toc-fl_005fswamp-1" href="#fl_005fswamp">7.4.10 fl_swamp</a></li>

39219

<li><a name="toc-fl_005fthief-1" href="#fl_005fthief">7.4.11 fl_thief</a></li>

39220

<li><a name="toc-fl_005fwater-1" href="#fl_005fwater">7.4.12 fl_water</a></li>

39221

39222

<li><a name="toc-fl_005fyinyang-1" href="#fl_005fyinyang">7.4.14 fl_yinyang</a></li>

39223

</ul>

39224

</li>

39225

</ul></li>

39226

<li><a name="toc-Item-Objects-1" href="#Item-Objects">8. Item Objects</a>

39227

39228

<li><a name="toc-Item-Overview-1" href="#Item-Overview">8.1 Item Overview</a></li>

39229

<li><a name="toc-Item-Attributes-1" href="#Item-Attributes">8.2 Item Attributes</a>

39230

39231

<li><a name="toc-fireproof-1" href="#fireproof">8.2.1 fireproof</a></li>

39232

<li><a name="toc-freezable-1" href="#freezable">8.2.2 freezable</a></li>

39233

<li><a name="toc-liftable-1" href="#liftable">8.2.3 liftable</a></li>

39234

<li><a name="toc-portable-1" href="#portable">8.2.4 portable</a></li>

39235

</ul></li>

39236

<li><a name="toc-Liftable-Items-1" href="#Liftable-Items">8.3 Liftable Items</a>

39237

39238

39239

<li><a name="toc-it_005fbanana-1" href="#it_005fbanana">8.3.2 it_banana</a></li>

39240

<li><a name="toc-it_005fbottle-1" href="#it_005fbottle">8.3.3 it_bottle</a></li>

39241

<li><a name="toc-it_005fbrake-1" href="#it_005fbrake">8.3.4 it_brake</a></li>

39242

<li><a name="toc-it_005fbrush-1" href="#it_005fbrush">8.3.5 it_brush</a></li>

39243

<li><a name="toc-it_005fcherry-1" href="#it_005fcherry">8.3.6 it_cherry</a></li>

39244

<li><a name="toc-it_005fcoffee-1" href="#it_005fcoffee">8.3.7 it_coffee</a></li>

39245

39246

<li><a name="toc-it_005fdocument-1" href="#it_005fdocument">8.3.9 it_document</a></li>

39247

39248

<li><a name="toc-it_005fdynamite-1" href="#it_005fdynamite">8.3.11 it_dynamite</a></li>

39249

<li><a name="toc-it_005fextinguisher-1" href="#it_005fextinguisher">8.3.12 it_extinguisher</a></li>

39250

<li><a name="toc-it_005fextralife-1" href="#it_005fextralife">8.3.13 it_extralife</a></li>

39251

39252

<li><a name="toc-it_005ffloppy-1" href="#it_005ffloppy">8.3.15 it_floppy</a></li>

39253

<li><a name="toc-it_005fglasses-1" href="#it_005fglasses">8.3.16 it_glasses</a></li>

39254

<li><a name="toc-it_005fhammer-1" href="#it_005fhammer">8.3.17 it_hammer</a></li>

39255

39256

<li><a name="toc-it_005fmagicwand-1" href="#it_005fmagicwand">8.3.19 it_magicwand</a></li>

39257

<li><a name="toc-it_005fpencil-1" href="#it_005fpencil">8.3.20 it_pencil</a></li>

39258

39259

39260

<li><a name="toc-it_005fpuller-1" href="#it_005fpuller">8.3.23 it_puller</a></li>

39261

39262

<li><a name="toc-it_005frubberband-1" href="#it_005frubberband">8.3.25 it_rubberband</a></li>

39263

39264

<li><a name="toc-it_005fspade-1" href="#it_005fspade">8.3.27 it_spade</a></li>

39265

<li><a name="toc-it_005fspoon-1" href="#it_005fspoon">8.3.28 it_spoon</a></li>

39266

<li><a name="toc-it_005fspring-1" href="#it_005fspring">8.3.29 it_spring</a></li>

39267

<li><a name="toc-it_005fsurprise-1" href="#it_005fsurprise">8.3.30 it_surprise</a></li>

39268

<li><a name="toc-it_005fsword-1" href="#it_005fsword">8.3.31 it_sword</a></li>

39269

<li><a name="toc-it_005fumbrella-1" href="#it_005fumbrella">8.3.32 it_umbrella</a></li>

39270

<li><a name="toc-it_005fweight-1" href="#it_005fweight">8.3.33 it_weight</a></li>

39271

<li><a name="toc-it_005fwrench-1" href="#it_005fwrench">8.3.34 it_wrench</a></li>

39272

<li><a name="toc-it_005fyinyang-1" href="#it_005fyinyang">8.3.35 it_yinyang</a></li>

39273

</ul></li>

39274

<li><a name="toc-Static-Items-1" href="#Static-Items">8.4 Static Items</a>

39275

39276

<li><a name="toc-it_005fblocker-1" href="#it_005fblocker">8.4.1 it_blocker</a></li>

39277

39278

<li><a name="toc-it_005fburnable-1" href="#it_005fburnable">8.4.3 it_burnable</a></li>

39279

<li><a name="toc-it_005fcrack-1" href="#it_005fcrack">8.4.4 it_crack</a></li>

39280

<li><a name="toc-it_005fcross-1" href="#it_005fcross">8.4.5 it_cross</a></li>

39281

<li><a name="toc-it_005fdeath-1" href="#it_005fdeath">8.4.6 it_death</a></li>

39282

<li><a name="toc-it_005fexplosion-1" href="#it_005fexplosion">8.4.7 it_explosion</a></li>

39283

<li><a name="toc-it_005flandmine-1" href="#it_005flandmine">8.4.8 it_landmine</a></li>

39284

<li><a name="toc-it_005flaserbeam-1" href="#it_005flaserbeam">8.4.9 it_laserbeam</a></li>

39285

<li><a name="toc-it_005fmagnet-1" href="#it_005fmagnet">8.4.10 it_magnet</a></li>

39286

<li><a name="toc-it_005fmeditation-1" href="#it_005fmeditation">8.4.11 it_meditation</a></li>

39287

<li><a name="toc-it_005fsensor-1" href="#it_005fsensor">8.4.12 it_sensor</a></li>

39288

<li><a name="toc-it_005fshogun-1" href="#it_005fshogun">8.4.13 it_shogun</a></li>

39289

<li><a name="toc-it_005fspringboard-1" href="#it_005fspringboard">8.4.14 it_springboard</a></li>

39290

<li><a name="toc-it_005fsquashed-1" href="#it_005fsquashed">8.4.15 it_squashed</a></li>

39291

<li><a name="toc-it_005fstrip-1" href="#it_005fstrip">8.4.16 it_strip</a></li>

39292

39293

<li><a name="toc-it_005ftrigger-1" href="#it_005ftrigger">8.4.18 it_trigger</a></li>

39294

<li><a name="toc-it_005fvortex-1" href="#it_005fvortex">8.4.19 it_vortex</a></li>

39295

<li><a name="toc-it_005fwormhole-1" href="#it_005fwormhole">8.4.20 it_wormhole</a></li>

39296

</ul>

39297

</li>

39298

</ul></li>

39299

<li><a name="toc-Stone-Objects-1" href="#Stone-Objects">9. Stone Objects</a>

39300

39301

<li><a name="toc-Stone-Overview-1" href="#Stone-Overview">9.1 Stone Overview</a></li>

39302

<li><a name="toc-Stone-Attributes-1" href="#Stone-Attributes">9.2 Stone Attributes</a>

39303

39304

<li><a name="toc-breakable-1" href="#breakable">9.2.1 breakable</a></li>

39305

<li><a name="toc-freeze_005fcheck-_0028stone_0029-1" href="#freeze_005fcheck-_0028stone_0029">9.2.2 freeze_check (stone)</a></li>

39306

39307

<li><a name="toc-hollow-1" href="#hollow">9.2.4 hollow</a></li>

39308

<li><a name="toc-hovering-1" href="#hovering">9.2.5 hovering</a></li>

39309

<li><a name="toc-movable-1" href="#movable">9.2.6 movable</a></li>

39310

<li><a name="toc-transparent-1" href="#transparent">9.2.7 transparent</a></li>

39311

</ul></li>

39312

<li><a name="toc-Standard-Stones-1" href="#Standard-Stones">9.3 Standard Stones</a>

39313

39314

<li><a name="toc-st_005fancient-1" href="#st_005fancient">9.3.1 st_ancient</a></li>

39315

<li><a name="toc-st_005fbluegray-1" href="#st_005fbluegray">9.3.2 st_bluegray</a></li>

39316

<li><a name="toc-st_005fbrownie-1" href="#st_005fbrownie">9.3.3 st_brownie</a></li>

39317

<li><a name="toc-st_005fbrownmarble-1" href="#st_005fbrownmarble">9.3.4 st_brownmarble</a></li>

39318

<li><a name="toc-st_005fcamouflage-1" href="#st_005fcamouflage">9.3.5 st_camouflage</a></li>

39319

<li><a name="toc-st_005fconcrete-1" href="#st_005fconcrete">9.3.6 st_concrete</a></li>

39320

<li><a name="toc-st_005fdarkgray-1" href="#st_005fdarkgray">9.3.7 st_darkgray</a></li>

39321

<li><a name="toc-st_005fgranite-1" href="#st_005fgranite">9.3.8 st_granite</a></li>

39322

<li><a name="toc-st_005fgreengray-1" href="#st_005fgreengray">9.3.9 st_greengray</a></li>

39323

<li><a name="toc-st_005finvisible-1" href="#st_005finvisible">9.3.10 st_invisible</a></li>

39324

<li><a name="toc-st_005fmetal-1" href="#st_005fmetal">9.3.11 st_metal</a></li>

39325

<li><a name="toc-st_005fpinkbumps-1" href="#st_005fpinkbumps">9.3.12 st_pinkbumps</a></li>

39326

<li><a name="toc-st_005fpurplegray-1" href="#st_005fpurplegray">9.3.13 st_purplegray</a></li>

39327

<li><a name="toc-st_005fpurplemarble-1" href="#st_005fpurplemarble">9.3.14 st_purplemarble</a></li>

39328

<li><a name="toc-st_005fredbrown-1" href="#st_005fredbrown">9.3.15 st_redbrown</a></li>

39329

<li><a name="toc-st_005fredmarble-1" href="#st_005fredmarble">9.3.16 st_redmarble</a></li>

39330

<li><a name="toc-st_005fredrock-1" href="#st_005fredrock">9.3.17 st_redrock</a></li>

39331

<li><a name="toc-st_005ftigris-1" href="#st_005ftigris">9.3.18 st_tigris</a></li>

39332

<li><a name="toc-st_005fwoven-1" href="#st_005fwoven">9.3.19 st_woven</a></li>

39333

<li><a name="toc-st_005fyellow-1" href="#st_005fyellow">9.3.20 st_yellow</a></li>

39334

</ul></li>

39335

<li><a name="toc-Cluster-Stones-1" href="#Cluster-Stones">9.4 Cluster Stones</a>

39336

39337

<li><a name="toc-Cluster-Features-1" href="#Cluster-Features">9.4.1 Cluster Features</a></li>

39338

<li><a name="toc-st_005fbluesand-1" href="#st_005fbluesand">9.4.2 st_bluesand</a></li>

39339

<li><a name="toc-st_005fbrick-1" href="#st_005fbrick">9.4.3 st_brick</a></li>

39340

<li><a name="toc-st_005fpanel-1" href="#st_005fpanel">9.4.4 st_panel</a></li>

39341

</ul></li>

39342

<li><a name="toc-Special-Stones-1" href="#Special-Stones">9.5 Special Stones</a>

39343

39344

<li><a name="toc-st_005factorimpulse-1" href="#st_005factorimpulse">9.5.1 st_actorimpulse</a></li>

39345

<li><a name="toc-st_005fbarrier-1" href="#st_005fbarrier">9.5.2 st_barrier</a></li>

39346

<li><a name="toc-st_005fbeads-1" href="#st_005fbeads">9.5.3 st_beads</a></li>

39347

<li><a name="toc-st_005fblocker-1" href="#st_005fblocker">9.5.4 st_blocker</a></li>

39348

39349

<li><a name="toc-st_005fboulder-1" href="#st_005fboulder">9.5.6 st_boulder</a></li>

39350

39351

<li><a name="toc-st_005fbrake-1" href="#st_005fbrake">9.5.8 st_brake</a></li>

39352

<li><a name="toc-st_005fbreak-1" href="#st_005fbreak">9.5.9 st_break</a></li>

39353

<li><a name="toc-st_005fbrownpyramid-1" href="#st_005fbrownpyramid">9.5.10 st_brownpyramid</a></li>

39354

<li><a name="toc-st_005fchameleon-1" href="#st_005fchameleon">9.5.11 st_chameleon</a></li>

39355

<li><a name="toc-st_005fcharge-1" href="#st_005fcharge">9.5.12 st_charge</a></li>

39356

<li><a name="toc-st_005fchess-1" href="#st_005fchess">9.5.13 st_chess</a></li>

39357

<li><a name="toc-st_005fcoinslot-1" href="#st_005fcoinslot">9.5.14 st_coinslot</a></li>

39358

<li><a name="toc-st_005fdarkglass-1" href="#st_005fdarkglass">9.5.15 st_darkglass</a></li>

39359

<li><a name="toc-st_005fdeath-1" href="#st_005fdeath">9.5.16 st_death</a></li>

39360

<li><a name="toc-st_005fdisco-1" href="#st_005fdisco">9.5.17 st_disco</a></li>

39361

<li><a name="toc-st_005fdispenser-1" href="#st_005fdispenser">9.5.18 st_dispenser</a></li>

39362

39363

39364

<li><a name="toc-st_005fflash-1" href="#st_005fflash">9.5.21 st_flash</a></li>

39365

39366

<li><a name="toc-st_005ffloppy-1" href="#st_005ffloppy">9.5.23 st_floppy</a></li>

39367

<li><a name="toc-st_005ffourswitch-1" href="#st_005ffourswitch">9.5.24 st_fourswitch</a></li>

39368

<li><a name="toc-st_005fghost-1" href="#st_005fghost">9.5.25 st_ghost</a></li>

39369

<li><a name="toc-st_005fgrate-1" href="#st_005fgrate">9.5.26 st_grate</a></li>

39370

<li><a name="toc-st_005fgreenbrown-1" href="#st_005fgreenbrown">9.5.27 st_greenbrown</a></li>

39371

39372

39373

39374

<li><a name="toc-st_005fknight-1" href="#st_005fknight">9.5.31 st_knight</a></li>

39375

<li><a name="toc-st_005flaser-1" href="#st_005flaser">9.5.32 st_laser</a></li>

39376

<li><a name="toc-st_005flaserflop-1" href="#st_005flaserflop">9.5.33 st_laserflop</a></li>

39377

<li><a name="toc-st_005flaserswitch-1" href="#st_005flaserswitch">9.5.34 st_laserswitch</a></li>

39378

<li><a name="toc-st_005flightglass-1" href="#st_005flightglass">9.5.35 st_lightglass</a></li>

39379

<li><a name="toc-st_005flightpassenger-1" href="#st_005flightpassenger">9.5.36 st_lightpassenger</a></li>

39380

<li><a name="toc-st_005fmagic-1" href="#st_005fmagic">9.5.37 st_magic</a></li>

39381

39382

<li><a name="toc-st_005fmirror-1" href="#st_005fmirror">9.5.39 st_mirror</a></li>

39383

<li><a name="toc-st_005fmonoflop-1" href="#st_005fmonoflop">9.5.40 st_monoflop</a></li>

39384

<li><a name="toc-st_005foneway-1" href="#st_005foneway">9.5.41 st_oneway</a></li>

39385

39386

<li><a name="toc-st_005fpassage-1" href="#st_005fpassage">9.5.43 st_passage</a></li>

39387

<li><a name="toc-st_005fplaster-1" href="#st_005fplaster">9.5.44 st_plaster</a></li>

39388

39389

<li><a name="toc-st_005fpolarswitch-1" href="#st_005fpolarswitch">9.5.46 st_polarswitch</a></li>

39390

<li><a name="toc-st_005fportal-1" href="#st_005fportal">9.5.47 st_portal</a></li>

39391

39392

<li><a name="toc-st_005fpuzzle-1" href="#st_005fpuzzle">9.5.49 st_puzzle</a></li>

39393

<li><a name="toc-st_005fquake-1" href="#st_005fquake">9.5.50 st_quake</a></li>

39394

<li><a name="toc-st_005frawglass-1" href="#st_005frawglass">9.5.51 st_rawglass</a></li>

39395

<li><a name="toc-st_005fredfiber-1" href="#st_005fredfiber">9.5.52 st_redfiber</a></li>

39396

<li><a name="toc-st_005frotator-1" href="#st_005frotator">9.5.53 st_rotator</a></li>

39397

<li><a name="toc-st_005frubberband-1" href="#st_005frubberband">9.5.54 st_rubberband</a></li>

39398

<li><a name="toc-st_005fscissors-1" href="#st_005fscissors">9.5.55 st_scissors</a></li>

39399

<li><a name="toc-st_005fshogun-1" href="#st_005fshogun">9.5.56 st_shogun</a></li>

39400

<li><a name="toc-st_005fspitter-1" href="#st_005fspitter">9.5.57 st_spitter</a></li>

39401

<li><a name="toc-st_005fstoneimpulse-1" href="#st_005fstoneimpulse">9.5.58 st_stoneimpulse</a></li>

39402

<li><a name="toc-st_005fsurprise-1" href="#st_005fsurprise">9.5.59 st_surprise</a></li>

39403

39404

<li><a name="toc-st_005fswitch-1" href="#st_005fswitch">9.5.61 st_switch</a></li>

39405

<li><a name="toc-st_005fthief-1" href="#st_005fthief">9.5.62 st_thief</a></li>

39406

<li><a name="toc-st_005ftimer-1" href="#st_005ftimer">9.5.63 st_timer</a></li>

39407

<li><a name="toc-st_005fturnstile-1" href="#st_005fturnstile">9.5.64 st_turnstile</a></li>

39408

<li><a name="toc-st_005fturnstilearm-1" href="#st_005fturnstilearm">9.5.65 st_turnstilearm</a></li>

39409

<li><a name="toc-st_005fvolcano-1" href="#st_005fvolcano">9.5.66 st_volcano</a></li>

39410

<li><a name="toc-st_005fwindow-1" href="#st_005fwindow">9.5.67 st_window</a></li>

39411

<li><a name="toc-st_005fyinyang-1" href="#st_005fyinyang">9.5.68 st_yinyang</a></li>

39412

</ul></li>

39413

<li><a name="toc-Stone-Feature-Summaries-1" href="#Stone-Feature-Summaries">9.6 Stone Feature Summaries</a>

39414

39415

<li><a name="toc-Transparent-Stones-1" href="#Transparent-Stones">9.6.1 Transparent Stones</a></li>

39416

<li><a name="toc-Breakable-Stones-1" href="#Breakable-Stones">9.6.2 Breakable Stones</a></li>

39417

</ul>

39418

</li>

39419

</ul></li>

39420

<li><a name="toc-Actor-Objects-1" href="#Actor-Objects">10. Actor Objects</a>

39421

39422

<li><a name="toc-Actor-Attributes-1" href="#Actor-Attributes">10.1 Actor Attributes</a>

39423

39424

<li><a name="toc-adhesion-_0028actor_0029-1" href="#adhesion-_0028actor_0029">10.1.1 adhesion (actor)</a></li>

39425

<li><a name="toc-charge-1" href="#charge">10.1.2 charge</a></li>

39426

<li><a name="toc-controllers-1" href="#controllers">10.1.3 controllers</a></li>

39427

<li><a name="toc-color-1" href="#color">10.1.4 color</a></li>

39428

<li><a name="toc-essential-1" href="#essential">10.1.5 essential</a></li>

39429

<li><a name="toc-essential_005fid-1" href="#essential_005fid">10.1.6 essential_id</a></li>

39430

<li><a name="toc-owner-1" href="#owner">10.1.7 owner</a></li>

39431

<li><a name="toc-velocity_005fx-1" href="#velocity_005fx">10.1.8 velocity_x</a></li>

39432

<li><a name="toc-velocity_005fy-1" href="#velocity_005fy">10.1.9 velocity_y</a></li>

39433

</ul></li>

39434

<li><a name="toc-Actors-1" href="#Actors">10.2 Actors</a>

39435

39436

39437

<li><a name="toc-ac_005fhorse-1" href="#ac_005fhorse">10.2.2 ac_horse</a></li>

39438

<li><a name="toc-ac_005fkiller-1" href="#ac_005fkiller">10.2.3 ac_killer</a></li>

39439

<li><a name="toc-ac_005fmarble-1" href="#ac_005fmarble">10.2.4 ac_marble</a></li>

39440

<li><a name="toc-ac_005fpearl-1" href="#ac_005fpearl">10.2.5 ac_pearl</a></li>

39441

<li><a name="toc-ac_005frotor-1" href="#ac_005frotor">10.2.6 ac_rotor</a></li>

39442

39443

</ul></li>

39444

<li><a name="toc-Actor-Features-1" href="#Actor-Features">10.3 Actor Features</a>

39445

39446

<li><a name="toc-Flying-Actors-1" href="#Flying-Actors">10.3.1 Flying Actors</a></li>

39447

</ul>

39448

</li>

39449

</ul></li>

39450

<li><a name="toc-Other-Objects-1" href="#Other-Objects">11. Other Objects</a>

39451

39452

<li><a name="toc-Visible-Others-1" href="#Visible-Others">11.1 Visible Others</a>

39453

39454

<li><a name="toc-ot_005fcannonball-1" href="#ot_005fcannonball">11.1.1 ot_cannonball</a></li>

39455

<li><a name="toc-ot_005frubberband-1" href="#ot_005frubberband">11.1.2 ot_rubberband</a></li>

39456

39457

</ul></li>

39458

<li><a name="toc-Gadgets-1" href="#Gadgets">11.2 Gadgets</a>

39459

39460

<li><a name="toc-ot_005fcounter-1" href="#ot_005fcounter">11.2.1 ot_counter</a></li>

39461

<li><a name="toc-ot_005ftimer-1" href="#ot_005ftimer">11.2.2 ot_timer</a></li>

39462

</ul>

39463

</li>

39464

</ul></li>

39465

<li><a name="toc-Libraries-1" href="#Libraries">12. Libraries</a>

39466

39467

<li><a name="toc-Basic-Functions-1" href="#Basic-Functions">12.1 Basic Functions</a></li>

39468

<li><a name="toc-liblua-1" href="#liblua">12.2 liblua</a>

39469

39470

<li><a name="toc-lib_002elua_002ecombine_005ftables-1" href="#lib_002elua_002ecombine_005ftables">12.2.1 lib.lua.combine_tables</a></li>

39471

39472

39473

<li><a name="toc-lib_002elua_002eprint_005ftable-1" href="#lib_002elua_002eprint_005ftable">12.2.4 lib.lua.print_table</a></li>

39474

<li><a name="toc-lib_002elua_002eshuffle-1" href="#lib_002elua_002eshuffle">12.2.5 lib.lua.shuffle</a></li>

39475

<li><a name="toc-lib_002elua_002eto_005fstring-1" href="#lib_002elua_002eto_005fstring">12.2.6 lib.lua.to_string</a></li>

39476

</ul></li>

39477

<li><a name="toc-libmath-1" href="#libmath">12.3 libmath</a>

39478

39479

<li><a name="toc-lib_002emath_002ecombinations-1" href="#lib_002emath_002ecombinations">12.3.1 lib.math.combinations</a></li>

39480

<li><a name="toc-lib_002emath_002ecubic_005fpolynomial-1" href="#lib_002emath_002ecubic_005fpolynomial">12.3.2 lib.math.cubic_polynomial</a></li>

39481

<li><a name="toc-lib_002emath_002ecyclic_005fpermutation-1" href="#lib_002emath_002ecyclic_005fpermutation">12.3.3 lib.math.cyclic_permutation</a></li>

39482

<li><a name="toc-lib_002emath_002edigits-1" href="#lib_002emath_002edigits">12.3.4 lib.math.digits</a></li>

39483

<li><a name="toc-lib_002emath_002emanhattan_005fdistance-1" href="#lib_002emath_002emanhattan_005fdistance">12.3.5 lib.math.manhattan_distance</a></li>

39484

<li><a name="toc-lib_002emath_002emark_005fcomponents-1" href="#lib_002emath_002emark_005fcomponents">12.3.6 lib.math.mark_components</a></li>

39485

<li><a name="toc-lib_002emath_002epermutation-1" href="#lib_002emath_002epermutation">12.3.7 lib.math.permutation</a></li>

39486

<li><a name="toc-lib_002emath_002erandom_005fvector-1" href="#lib_002emath_002erandom_005fvector">12.3.8 lib.math.random_vector</a></li>

39487

<li><a name="toc-lib_002emath_002esteps-1" href="#lib_002emath_002esteps">12.3.9 lib.math.steps</a></li>

39488

</ul></li>

39489

<li><a name="toc-libmap-1" href="#libmap">12.4 libmap</a>

39490

39491

<li><a name="toc-Creating-Maps-1" href="#Creating-Maps">12.4.1 Creating Maps</a></li>

39492

<li><a name="toc-Drawing-Maps-1" href="#Drawing-Maps">12.4.2 Drawing Maps</a></li>

39493

<li><a name="toc-Rotating-and-Mirroring-Maps-1" href="#Rotating-and-Mirroring-Maps">12.4.3 Rotating and Mirroring Maps</a></li>

39494

<li><a name="toc-Requesting-and-Changing-Single-Map-Entries-1" href="#Requesting-and-Changing-Single-Map-Entries">12.4.4 Requesting and Changing Single Map Entries</a></li>

39495

<li><a name="toc-Connecting-Two-Maps-1" href="#Connecting-Two-Maps">12.4.5 Connecting Two Maps</a></li>

39496

<li><a name="toc-Other-Map-Tasks-1" href="#Other-Map-Tasks">12.4.6 Other Map Tasks</a></li>

39497

<li><a name="toc-newMap-1" href="#newMap">12.4.7 newMap</a></li>

39498

<li><a name="toc-Map-Entry-Request-1" href="#Map-Entry-Request">12.4.8 Map Entry Request</a></li>

39499

<li><a name="toc-Map-Transformation-1" href="#Map-Transformation">12.4.9 Map Transformation</a></li>

39500

<li><a name="toc-Map-Horizontal-Concatenation-1" href="#Map-Horizontal-Concatenation">12.4.10 Map Horizontal Concatenation</a></li>

39501

<li><a name="toc-Map-Vertical-Concatenation-1" href="#Map-Vertical-Concatenation">12.4.11 Map Vertical Concatenation</a></li>

39502

<li><a name="toc-Map-Fusing-1" href="#Map-Fusing">12.4.12 Map Fusing</a></li>

39503

<li><a name="toc-Map-Default-Keys-1" href="#Map-Default-Keys">12.4.13 Map Default Keys</a></li>

39504

<li><a name="toc-Map-Width-and-Height-1" href="#Map-Width-and-Height">12.4.14 Map Width and Height</a></li>

39505

<li><a name="toc-lib_002emap_002ecovers-1" href="#lib_002emap_002ecovers">12.4.15 lib.map.covers</a></li>

39506

<li><a name="toc-lib_002emap_002edefuse-1" href="#lib_002emap_002edefuse">12.4.16 lib.map.defuse</a></li>

39507

<li><a name="toc-lib_002emap_002eextend-1" href="#lib_002emap_002eextend">12.4.17 lib.map.extend</a></li>

39508

<li><a name="toc-lib_002emap_002ematch-1" href="#lib_002emap_002ematch">12.4.18 lib.map.match</a></li>

39509

<li><a name="toc-lib_002emap_002epaste-1" href="#lib_002emap_002epaste">12.4.19 lib.map.paste</a></li>

39510

<li><a name="toc-lib_002emap_002eprint-1" href="#lib_002emap_002eprint">12.4.20 lib.map.print</a></li>

39511

<li><a name="toc-lib_002emap_002ereplace-1" href="#lib_002emap_002ereplace">12.4.21 lib.map.replace</a></li>

39512

<li><a name="toc-lib_002emap_002ereplace_005foutside-1" href="#lib_002emap_002ereplace_005foutside">12.4.22 lib.map.replace_outside</a></li>

39513

39514

39515

<li><a name="toc-Map-Transformation-Index-and-MAP_005fALL-1" href="#Map-Transformation-Index-and-MAP_005fALL">12.4.25 Map Transformation Index and MAP_ALL</a></li>

39516

<li><a name="toc-Map-Transformation-Composition-and-Powers-1" href="#Map-Transformation-Composition-and-Powers">12.4.26 Map Transformation Composition and Powers</a></li>

39517

<li><a name="toc-Map-Transformation-Inverse-1" href="#Map-Transformation-Inverse">12.4.27 Map Transformation Inverse</a></li>

39518

<li><a name="toc-Random-Map-Transformations-1" href="#Random-Map-Transformations">12.4.28 Random Map Transformations</a></li>

39519

</ul></li>

39520

<li><a name="toc-libimport-1" href="#libimport">12.5 libimport</a>

39521

39522

<li><a name="toc-lib_002eimport_002eunpack_005fmultilevel-1" href="#lib_002eimport_002eunpack_005fmultilevel">12.5.1 lib.import.unpack_multilevel</a></li>

39523

<li><a name="toc-lib_002eimport_002euncompress_005frle-1" href="#lib_002eimport_002euncompress_005frle">12.5.2 lib.import.uncompress_rle</a></li>

39524

<li><a name="toc-lib_002eimport_002elevel_005fto_005fmap-1" href="#lib_002eimport_002elevel_005fto_005fmap">12.5.3 lib.import.level_to_map</a></li>

39525

<li><a name="toc-lib_002eimport_002emap_005fsokoban-1" href="#lib_002eimport_002emap_005fsokoban">12.5.4 lib.import.map_sokoban</a></li>

39526

<li><a name="toc-lib_002eimport_002emap_005fwanderer-1" href="#lib_002eimport_002emap_005fwanderer">12.5.5 lib.import.map_wanderer</a></li>

39527

</ul></li>

39528

<li><a name="toc-libsoko-1" href="#libsoko">12.6 libsoko</a></li>

39529

</ul></li>

39530

<li><a name="toc-Advanced-Features-1" href="#Advanced-Features">13. Advanced Features</a>

39531

39532

<li><a name="toc-Resolvers-1" href="#Resolvers">13.1 Resolvers</a>

39533

39534

<li><a name="toc-Resolver-Chaining-1" href="#Resolver-Chaining">13.1.1 Resolver Chaining</a></li>

39535

<li><a name="toc-Custom-Resolver-1" href="#Custom-Resolver">13.1.2 Custom Resolver</a></li>

39536

<li><a name="toc-res_002eautotile-1" href="#res_002eautotile">13.1.3 res.autotile</a></li>

39537

<li><a name="toc-res_002ecomposer-1" href="#res_002ecomposer">13.1.4 res.composer</a></li>

39538

39539

<li><a name="toc-res_002epuzzle-1" href="#res_002epuzzle">13.1.6 res.puzzle</a></li>

39540

<li><a name="toc-res_002erandom-1" href="#res_002erandom">13.1.7 res.random</a></li>

39541

<li><a name="toc-res_002etrain-1" href="#res_002etrain">13.1.8 res.train</a></li>

39542

</ul></li>

39543

<li><a name="toc-General-Features-1" href="#General-Features">13.2 General Features</a>

39544

39545

<li><a name="toc-Display-Follow-Strategy-1" href="#Display-Follow-Strategy">13.2.1 Display Follow Strategy</a></li>

39546

<li><a name="toc-Flood-Spreading-1" href="#Flood-Spreading">13.2.2 Flood Spreading</a></li>

39547

<li><a name="toc-Fire-Spreading-1" href="#Fire-Spreading">13.2.3 Fire Spreading</a></li>

39548

<li><a name="toc-Heat_002dTransformation-1" href="#Heat_002dTransformation">13.2.4 Heat-Transformation</a></li>

39549

<li><a name="toc-Freeze-Checking-1" href="#Freeze-Checking">13.2.5 Freeze Checking</a></li>

39550

</ul></li>

39551

<li><a name="toc-Tips-and-Tricks-1" href="#Tips-and-Tricks">13.3 Tips and Tricks</a>

39552

39553

<li><a name="toc-Nearest-Object-Clustering-1" href="#Nearest-Object-Clustering">13.3.1 Nearest Object Clustering</a></li>

39554

<li><a name="toc-Orthogonal-Autotiling-1" href="#Orthogonal-Autotiling">13.3.2 Orthogonal Autotiling</a></li>

39555

</ul>

39556

</li>

39557

</ul></li>

39558

<li><a name="toc-Extension-Development-1" href="#Extension-Development">14. Extension Development</a>

39559

39560

<li><a name="toc-Resolver-Development-1" href="#Resolver-Development">14.1 Resolver Development</a>

39561

39562

<li><a name="toc-Resolver-Configurator-1" href="#Resolver-Configurator">14.1.1 Resolver Configurator</a></li>

39563

<li><a name="toc-Resolver-Implementation-1" href="#Resolver-Implementation">14.1.2 Resolver Implementation</a></li>

39564

<li><a name="toc-Resolver-Finalizer-1" href="#Resolver-Finalizer">14.1.3 Resolver Finalizer</a></li>

39565

</ul>

39566

</li>

39567

</ul></li>

39568

<li><a name="toc-Guidelines-and-Hints-1" href="#Guidelines-and-Hints">15. Guidelines and Hints</a>

39569

39570

<li><a name="toc-Filename-Recommendation-1" href="#Filename-Recommendation">15.1 Filename Recommendation</a></li>

39571

<li><a name="toc-Title-Recommendation-1" href="#Title-Recommendation">15.2 Title Recommendation</a></li>

39572

<li><a name="toc-Tile-Key-Recommendation-1" href="#Tile-Key-Recommendation">15.3 Tile Key Recommendation</a></li>

39573

<li><a name="toc-Easy-Mode-Hints-1" href="#Easy-Mode-Hints">15.4 Easy Mode Hints</a></li>

39574

</ul></li>

39575

<li><a name="toc-Compatibility-1" href="#Compatibility">16. Compatibility</a>

39576

39577

<li><a name="toc-Engine-Compatibility-1" href="#Engine-Compatibility">16.1 Engine Compatibility</a></li>

39578

</ul></li>

39579

<li><a name="toc-Object-Index-1" href="#Object-Index">Object Index</a></li>

39580

<li><a name="toc-Attribute-Index-1" href="#Attribute-Index">Attribute Index</a></li>

39581

<li><a name="toc-Message-Index-1" href="#Message-Index">Message Index</a></li>

39582

<li><a name="toc-Function-Index-1" href="#Function-Index">Function Index</a></li>

39583

<li><a name="toc-Concept-Index-1" href="#Concept-Index">Concept Index</a></li>

39584

<li><a name="toc-Renaming-Index-1" href="#Renaming-Index">Renaming Index</a></li>

39585

</ul>

39586

</div>

39587

39588

39589

39590

39591

<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>

39592

<td valign="middle" align="left">[<a href="#Object-Index" title="Index">Index</a>]</td>

39593

39594

</tr></table>

39595

<h1>About This Document</h1>

39596

39597

This document was generated by Andreas Lochmann on April 1, 2013 using <a href="http://www.nongnu.org/texi2html/">texi2html 1.82</a>.

39598

39599

39600

The buttons in the navigation panels have the following meaning:

39601

39602

39603

<tr>

39604

<th> Button </th>

39605

39606

39607

39608

</tr>

39609

<tr>

39610

39611

39612

<td>Previous section in reading order</td>

39613

39614

</tr>

39615

<tr>

39616

39617

<td align="center">Forward</td>

39618

<td>Next section in reading order</td>

39619

39620

</tr>

39621

<tr>

39622

39623

<td align="center">FastBack</td>

39624

<td>Beginning of this chapter or previous chapter</td>

39625

39626

</tr>

39627

<tr>

39628

39629

39630

<td>Up section</td>

39631

39632

</tr>

39633

<tr>

39634

39635

<td align="center">FastForward</td>

39636

<td>Next chapter</td>

39637

39638

</tr>

39639

<tr>

39640

39641

39642

<td>Cover (top) of document</td>

39643

39644

</tr>

39645

<tr>

39646

<td align="center"> [Contents] </td>

39647

<td align="center">Contents</td>

39648

<td>Table of contents</td>

39649

39650

</tr>

39651

<tr>

39652

<td align="center"> [Index] </td>

39653

<td align="center">Index</td>

39654

<td>Index</td>

39655

39656

</tr>

39657

<tr>

39658

39659

<td align="center">About</td>

39660

<td>About (help)</td>

39661

39662

</tr>

39663

</table>

39664

39665

39666

where the Example assumes that the current position is at Subsubsection One-Two-Three of a document of the following structure:

39667

39668

39669

<ul>

39670

<li> 1. Section One

39671

<ul>

39672

<li>1.1 Subsection One-One

39673

<ul>

39674

39675

</ul>

39676

</li>

39677

<li>1.2 Subsection One-Two

39678

<ul>

39679

<li>1.2.1 Subsubsection One-Two-One</li>

39680

<li>1.2.2 Subsubsection One-Two-Two</li>

39681

<li>1.2.3 Subsubsection One-Two-Three

39682

<== Current Position </li>

39683

<li>1.2.4 Subsubsection One-Two-Four</li>

39684

</ul>

39685

</li>

39686

<li>1.3 Subsection One-Three

39687

<ul>

39688

39689

</ul>

39690

</li>

39691

<li>1.4 Subsection One-Four</li>

39692

</ul>

39693

</li>

39694

</ul>

39695

39696

39697

39698

39699

This document was generated by Andreas Lochmann on April 1, 2013 using <a href="http://www.nongnu.org/texi2html/">texi2html 1.82</a>.

39700

39701

39702

39703

39704

</body>

39705

</html>