-
Notifications
You must be signed in to change notification settings - Fork 7
/
designguide.html
12531 lines (4688 loc) · 289 KB
/
designguide.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Skyscraper Building Design Guide</title>
<meta http-equiv="content-type" content="text/html;
charset=windows-1252">
</head>
<body>
<div align="center">
<p><strong><font size="+2">Skyscraper 1.12<br>
Building Design Guide<br>
</font></strong>Copyright (C)2005-2024 Ryan Thoryk</p>
<hr>
<p align="left">This document describes how to create your own
buildings for the Skyscraper simulator, and also describes all
of the available commands. Please note that the commands and
syntax will change frequently during the simulator's
development, and formatting will be cleaned up to make the code
more readable. A graphical building designer is planned, which
will generate these script files based on simplified CAD-like
floorplan layouts, and will also allow the user to view the
building in 3D as it's being created.</p>
<p align="left"> </p>
<p align="center"><font size="+1"><strong><u>Contents</u></strong></font></p>
<p align="center"><a href="#Start">Starting a new building</a></p>
<p align="center"><a href="#General">General Stuff</a></p>
<p align="center"><a href="#Globals">Globals Section</a></p>
<p align="center"><a href="#Textures">Textures Section</a></p>
<p align="center"><a href="#Floor">Floor Sections</a></p>
<p align="center"><a href="#Elevator">Elevator Sections</a></p>
<p align="center"><a href="#Car">Car (Elevator) Sections</a></p>
<p align="center"><a href="#Controller">Controller Sections</a></p>
<p align="center"><a href="#CallStation">CallStation Sections</a></p>
<p align="center"><a href="#GlobalCommands">Global Commands</a></p>
<p align="center"><a href="#ExtendedCommands">Extended Commands</a></p>
<p align="center"><a href="#Functions">Predefined Functions</a></p>
<p align="center"><a href="#Buildings">Buildings Section</a></p>
<p align="center"><a href="#Vehicles">Vehicles Section</a></p>
<p align="center"><a href="#Example">Example Building</a></p>
<p align="left"> </p>
<p align="left"><strong><font size="+1"><a name="Start"></a>1.
Starting a new building</font></strong></p>
<p align="left">Buildings are stored in text files in Skyscraper's
<em>buildings</em> folder, usually at "c:\program
files\skyscraper\buildings" on Windows, or in the "buildings"
directory on Unix. The filenames end in BLD, and so you need to
make sure your text file ends with ".bld" and not ".txt". To
create a new building, first open up a text editor, and read the
instructions below. When you're finished, save it into the <em>buildings</em>
folder shown above, as something like "mybuilding.bld". The
building will appear when you choose "Other buildings..." in
Skyscraper's main menu the next time you run it. A simplistic
building is included for you to get a good idea of the overall
format of a typical building data file. You might also want to
open one of the other buildings that come with Skyscraper
("Triton Center.bld", "Glass Tower.bld", etc) for examples on
the more advanced functions. Please note that the script syntax
will change in the future.</p>
<p align="left"> </p>
<p align="left"><strong><font size="+1"><a name="General"></a>2.
General Stuff</font></strong></p>
<p align="left"><strong>1. Comments</strong></p>
<p align="left">To add a comment to your file, simply put the #
symbol right before your comment. For example:<br>
<font size="2" face="Courier New, Courier, mono"># This is a
comment</font></p>
<p align="left">It's a good idea to use comment markers to add a
title header at the top of your building file. The Triton Center
file has this header:<br>
<font size="2" face="Courier New, Courier, mono">#The Triton
Center<br>
#Copyright �2002-2013 Ryan Thoryk</font></p>
<p align="left"><br>
<strong>2. Variables</strong></p>
<p align="left">Variables are marked with percent signs (%), and
most system variables will be described later. Variables can be
set using the Set command:<font size="2" face="Courier New,
Courier, mono"><br>
Set myvariable = 100<br>
</font>and then can be used later:<font size="2" face="Courier
New, Courier, mono"><br>
Height = %myvariable%<br>
<br>
</font></p>
<p align="left"><strong>3. IF/While statements</strong></p>
<p align="left">Basic IF and While statements can be made, with
the following syntax:<br>
<font size="2" face="Courier New, Courier, mono">if[<em>expression</em>]
command<br>
while[<em>expression</em>] command</font></p>
<p align="left">Available signs are = (equals), > (greater
than), < (less than), ! (is not), & (and) and | (or).
Expressions can also be enclosed in parenthesis. Note that
IF/While statements only work with the current line, and do not
currently support multiple lines within an IF/While block, an
"else" statement, or nesting. A While statement will loop the
current line until the expression is false, so be careful with
this because it can create an infinite loop if the expression is
always true. See the <em>Functions</em> section below for an
example of a While statement.</p>
<p align="left">For example, to set the height to 9.5 if the floor
number is less than 82:<br>
<font size="2" face="Courier New, Courier, mono">if[%floor% <
82] Height = 9.5</font></p>
<p align="left">This example shows a complex expression:<br>
<font size="2" face="Courier New, Courier, mono">if[%floor% <
82 & (%height% = 3 | %height% = 5)] Height = 9.5</font></p>
<p align="left">In the above example, the statement will be true
if the <em>floor</em> value is less than 82 and if the <em>height</em>
value is either 3 or 5.<br>
<br>
</p>
<p align="left"><strong>4. Inline calculations</strong></p>
<p align="left">Values can be calculated inline by using the
following math operators: <br>
+ (plus), - (minus), / (divide), * (multiply), and ^ (power of)</p>
<p align="left">They can be used anywhere in the data file. Here's
an example of one being used with the Set command:<br>
<font size="2" face="Courier New, Courier, mono">Set 1 =
%floorheight% + 10</font></p>
<p align="left">Parenthesis are also supported, for grouped
operations. Here's an example of a complex math expression:<br>
<font size="2" face="Courier New, Courier, mono">Set 5 =
%height% + (%interfloorheight% * (4 / %altitude%))</font></p>
<p align="left"><font size="2" face="Courier New, Courier, mono"><br>
</font><strong>5. Object parameters from outside floor sections</strong></p>
<p align="left">Information about a certain floor can be obtained
elsewhere in the script, by referencing the floor in this
manner:</p>
<p align="left"><font size="2" face="Courier New, Courier, mono">Floor(<em>number</em>).<em>parameter</em></font></p>
<p align="left">Available parameters are <em>Base</em>, <em>Altitude</em>,
<em>Height</em>, <em>FullHeight</em> and <em>InterfloorHeight</em>.
Note that this function must only be called after the specified
floor has been created.<br>
If the <em>InterfloorOnTop</em> parameter in the globals
section is set to 'false' (the default), then <em>Base</em>
(slab height) refers to the floor's altitude plus interfloor
height; otherwise it refers to the altitude.</p>
<p align="left">Example:<font size="2" face="Courier New, Courier,
mono"><br>
Set 1 = Floor(5).Altitude</font></p>
<p align="left"><strong><font size="2" face="Courier New, Courier,
mono"><br>
</font>6. Includes</strong></p>
<p align="left">Other script files can be included (inserted)
anywhere in the current script by using the <Include>
command. Scripts can be included multiple times, and included
scripts can include other scripts.</p>
<p align="left">Syntax:<br>
<font size="2" face="Courier New, Courier, mono"><Include <em>filename</em>></font></p>
<p align="left">To include a file called test.txt that's in the
data folder, you would enter:<br>
<font size="2" face="Courier New, Courier, mono"><br>
<Include data/test.txt><br>
</font></p>
<p align="left"><br>
<strong>7. Functions</strong></p>
<p align="left">Functions can be created to share code between
sections of scripts, and also between entire scripts when used
in conjunction with includes. An unlimited number of parameters
can be specified for each function. If a function is specified
with the same name as a previously defined function, the
function will be skipped and a warning will be printed. This can
only be used outside of any section, such as <Floor>.</p>
<p align="left">Syntax:<br>
<font size="2" face="Courier New, Courier, mono"><Function <em>name</em>><br>
<em>(code)</em><br>
<EndFunction> </font></p>
<p align="left">The above is a function definition, and must be
used before the function call. Functions can be called from
anywhere in the script, and can also call other functions,
resulting in nested functions. To call the function later in
your code, use the function name followed by a list of
parameters contained within parenthesis, or just parenthesis if
you're not passing any parameters:</p>
<p align="left">Syntax:<br>
<em>name</em>(<em>parameter1</em>, <em>parameter2</em>, ...)<br>
or<br>
name()<br>
<br>
The parameters appear as variables inside the function in the
form of <font size="2" face="Courier New, Courier, mono">%param#%</font>
- so the first parameter passed is <font size="2" face="Courier
New, Courier, mono">%param1%</font>, the second is <font
size="2" face="Courier New, Courier, mono">%param2%</font>,
etc. For an example, I'll create a function called Test with a
single SetAutoSize command within it, and call that function:</p>
</div>
<div align="left">
<p><font size="2" face="Courier New, Courier, mono"><Function
test><br>
SetAutoSize = %param1%, %param2%<br>
<EndFunction><br>
<br>
test(false, false)</font></p>
<p>In the above example, the command that ends up being performed
is "SetAutoSize = false, false". Here is an example of using a
While statement to loop a function:</p>
<p><font size="2" face="Courier New, Courier, mono">set a = 0<br>
<Function testing><br>
set a = %a% + 1<br>
print %a%<br>
<EndFunction><br>
<br>
while [%a% < 5] testing()<br>
print finished</font></p>
<p>The console output of that ends up being:</p>
<p><font size="2" face="Courier New, Courier, mono">1<br>
2<br>
3<br>
4<br>
5<br>
finished</font></p>
<p align="left"><br>
<strong>8. Advanced Math Functions</strong></p>
<p align="left">Several built-in advanced math functions are
provided, mostly for trigonometric calculations.</p>
<p align="left">Syntax and descriptions:<br>
<br>
cos(<em>x</em>) - calculate cosine, x is angle in radians<br>
sine(<em>x</em>) - calculate sine, x is angle in radians<br>
tan(<em>x</em>) - calculate tangent, x is angle in radians<br>
acos(<em>x</em>) - calculate arc cosine, x is a value from -1 to
1<br>
asin(<em>x</em>) - calculate arc sine, x is a value from -1 to 1<br>
atan(<em>x</em>) - calculate arc tangent<br>
atan2(<em>y</em>, <em>x</em>) - calculate arc tangent with two
values, one for the y-coordinate and one for the x<br>
sqrt(<em>x</em>) - calculate square root<br>
abs(<em>x</em>) - calculate absolute value<br>
exp(<em>x</em>) - calculate exponential function<br>
log(<em>x</em>) - calculate natural logarithm<br>
log2(<em>x</em>) - calculate binary logarithm<br>
log10(<em>x</em>) - calculate common logarithm<br>
mod(<em>number</em>, <em>denominator</em>) - calculate modulo
(remainder) of a division<br>
hypot(<em>x</em>, <em>y</em>) - calculate hypotenuse<br>
ceil(<em>number</em>) - calculate ceiling (round up)<br>
flr(<em>number</em>) - calculate floor (round down)<br>
rnd(<em>limit</em>) - generate random number from 0 to limit<br>
round(<em>number, decimals</em>) - round number to nearest
value; the <em>decimals</em> parameter is optional<br>
</p>
<p align="left"><strong><br>
9. For loops</strong></p>
<p align="left">For loops can be created by specifying an iterator
variable, and the range to use, with the following syntax:<br>
<font size="2" face="Courier New, Courier, mono"><For <i>iterator</i>
<i>start</i> To <i>end></i><br>
<i>(code)</i><br>
<EndFor></font></p>
<p align="left">The For loop will loop until it completes the
"end" value, and can iterate up or down. The value of the
iteration is stored in the iterator variable and the variable
name must be unique.<br>
In the following example, the iterator variable will be printed
out on each iteration:<br>
<font size="2" face="Courier New, Courier, mono"><For <i>i 1
to 3></i><br>
P<i>rint %i%</i><br>
<EndFor></font></p>
<p align="left">When the code is run, this is the result:<br>
<font size="2" face="Courier New, Courier, mono">1<br>
2<br>
3<br>
</font></p>
For loops can be nested, like this:<br>
<font size="2" face="Courier New, Courier, mono"><For <i>i 1
to 3></i><br>
<For j 1 to 4><br>
<i>Print %i%</i> : %j%<br>
<EndFor><br>
<EndFor><br>
<br>
</font>
<p align="left">When the code is run, this is the result:<br>
<font size="2" face="Courier New, Courier, mono">1 : 1<br>
</font><font size="2" face="Courier New, Courier, mono"><font
size="2" face="Courier New, Courier, mono">1 : 2<br>
</font></font><font size="2" face="Courier New, Courier, mono"><font
size="2" face="Courier New, Courier, mono"><font size="2"
face="Courier New, Courier, mono">1 : 3<br>
</font></font></font><font size="2" face="Courier New,
Courier, mono"><font size="2" face="Courier New, Courier,
mono"><font size="2" face="Courier New, Courier, mono"><font
size="2" face="Courier New, Courier, mono">1 : 4<br>
</font></font></font></font><font size="2" face="Courier
New, Courier, mono"><font size="2" face="Courier New, Courier,
mono">2 : 1<br>
</font></font><font size="2" face="Courier New, Courier, mono"><font
size="2" face="Courier New, Courier, mono"><font size="2"
face="Courier New, Courier, mono">2 : 2<br>
</font></font></font><font size="2" face="Courier New,
Courier, mono"><font size="2" face="Courier New, Courier,
mono"><font size="2" face="Courier New, Courier, mono"><font
size="2" face="Courier New, Courier, mono">2 : 3<br>
</font></font></font>2 : 4<br>
3 : 1<br>
</font><font size="2" face="Courier New, Courier, mono"><font
size="2" face="Courier New, Courier, mono">3 : 2</font><br>
</font><font size="2" face="Courier New, Courier, mono"><font
size="2" face="Courier New, Courier, mono">3 : 3<br>
</font></font><font size="2" face="Courier New, Courier, mono">3
: 4</font><br>
</p>
<br>
</div>
<div align="center">
<p align="left"><strong><font size="+1"><a name="Globals"></a>3.
The <em>Globals</em> Section</font></strong></p>
<p align="left">The <em>Globals</em> section contains the general
information about your building. This section is required, since
it determines if a building file is valid. The section starts
with this header:<br>
<font size="2" face="Courier New, Courier, mono"><Globals></font></p>
<p align="left">and ends with this footer:<br>
<font size="2" face="Courier New, Courier, mono"><EndGlobals></font></p>
<p align="left">Parameters are placed between those two markers,
and look like this:<br>
<font size="2" face="Courier New, Courier, mono">Parameter = <em>value</em></font></p>
<p align="left">Example:<br>
<font size="2" face="Courier New, Courier, mono">Name = Triton
Center</font></p>
<p align="left"><strong>Parameters (all are optional):</strong></p>
<p align="left"><strong>1. Name</strong> - building name<br>
Example: <font size="2" face="Courier New, Courier, mono">Name
= My Building</font></p>
<p align="left"><strong>2. Designer</strong> - name of building's
designer<br>
<font size="2" face="Courier New, Courier, mono">Designer = Me</font><br>
<br>
<strong>3. Location</strong> - location of the building<br>
<font size="2" face="Courier New, Courier, mono">Location = 100
Main Street</font></p>
<p align="left"><strong>4. Description</strong> - Brief
description of the building<br>
<font size="2" face="Courier New, Courier, mono">Description = A
really average building</font><br>
<br>
<strong>5. Version</strong> - Version of the building (can be
text)<br>
<font size="2" face="Courier New, Courier, mono">Version = 1</font><br>
<br>
<strong>6. CameraFloor</strong> - camera's starting floor,
starting with 0 (like Floors command) - default is 0<br>
<font size="2" face="Courier New, Courier, mono">CameraFloor = 0</font><br>
<br>
<strong>7. CameraPosition</strong> - camera's starting position
in X (left/right) and Z (forward/backward) feet coordinates -
default is "0, 0"<br>
Syntax: <font size="2" face="Courier New, Courier, mono">CameraPosition
= <em>X</em>, <em>Z</em></font><br>
<font size="2" face="Courier New, Courier, mono">CameraPosition
= 0, -10</font><br>
<br>
<strong>8. CameraDirection</strong> - specifies a 3D point that
the camera is looking at on startup (instead of specifying
rotation), in X (left/right), Y (up down), and Z
(forward/backward) feet coordinates.<br>
<font size="2" face="Courier New, Courier, mono">CameraDirection
= 0, 10, 28.8</font></p>
<p align="left"><strong>9. CameraRotation</strong> - axis rotation
of the camera on startup - X is degrees up/down, Y is degrees
left/right, and Z is spin. Default is "0, 0, 0", and the example
makes the camera face right.<br>
Syntax: <font size="2" face="Courier New, Courier, mono">CameraRotation
= <em>X</em>, <em>Y</em>, <em>Z</em></font><br>
<font size="2" face="Courier New, Courier, mono">CameraRotation
= 0, 90, 0</font></p>
<p align="left"><strong>10. Sky</strong> - which skybox texture
pack to use, if the Caelum sky system is off. In the following
example, the chosen pack is "noon", and the file "sky-noon.zip"
will be loaded. Default is "noon".<br>
<font size="2" face="Courier New, Courier, mono">Sky = noon<br>
</font></p>
<p align="left"><strong>11. DynamicSky </strong>- which Caelum
sky script to use. In the following example, the script is
"RainWind", which is listed in the data/caelum/sky.os resource
file. Default is "DefaultSky".<br>
<font size="2" face="Courier New, Courier, mono">DynamicSky =
RainWind<br>
</font></p>
<p style="text-align:left;margin-left:0;margin-right:auto;">Available
sky types in data/caelum/sky.os file:<br>
DefaultBase<br>
DefaultSky<br>
Cloudy<br>
Overcast<br>
BigPuffyStars<br>
BigPuffyStarsWithFogComposer<br>
MidnightSun<br>
Eclipse<br>
FogSky<br>
RainWind<br>
RainUp<br>
ShadowDebug<br>
HugeAmbientFactor<br>
BasicCloud<br>
OverrideCloud<br>
CloudMesh<br>
CloudFade<br>
SkyDomeOverrideHazeTest<br>
GroundFogNoise<br>
SandStormTest</p>
<p align="left"><strong>12. InterfloorOnTop</strong> - determines
if the interfloor area should be located at the bottom or top of
each floor. Interfloor areas represent the area used by floor
trusses (supports), between a level's ceiling and the next
level. Since each floor needs supports below it, the default is
false.<br>
<font size="2" face="Courier New, Courier, mono">InterfloorOnTop
= true</font></p>
<p align="left"><strong>13. Collisions</strong> - enables/disables
collisions (default is true)<br>
<font size="2" face="Courier New, Courier, mono">Collisions =
false</font></p>
<p align="left"><strong>14. Gravity</strong> - enables/disables
gravity (default is true)<br>
<font size="2" face="Courier New, Courier, mono">Gravity = false</font></p>
<p align="left"><strong>15. Coordinates</strong> - set latitude
and longitude of building (for sky system)<br>
<font size="2" face="Courier New, Courier, mono">Coordinates =
41.883, -87.629</font></p>
<p align="left"><strong>16. DateTime</strong> - set UTC date/time
on startup (in Julian value), for sky system, or set to "now" to
use the current system time<br>
<font size="2" face="Courier New, Courier, mono">DateTime =
2457197.1254</font><br>
<font size="2" face="Courier New, Courier, mono">DateTime = now</font></p>
<p align="left"><strong>17. TimeScale</strong> - sets the time
multiplier for the sky system. The default is 25. Set to 1 for
real-time.<br>
<font size="2" face="Courier New, Courier, mono">TimeScale = 1</font><br>
</p>
<p align="left"><strong>18. Position</strong> - set the 3D
position of this building, used when loading multiple buildings.
See the Load command in the Buildings section for more
information.<br>
Syntax: <font size="2" face="Courier New, Courier, mono">Position
= <em>X, Y, Z</em></font><br>
Example: <font size="2" face="Courier New, Courier, mono">Position
= 100, 0, 100</font></p>
<p align="left"><strong>19. Rotation</strong> - set the 3D
rotation (Y axis, which is left/right), in degrees, of this
building, used when loading multiple buildings. See the Load
command in the Buildings section for more information.<br>
Syntax: <font size="2" face="Courier New, Courier, mono">Rotation
= <em>value</em></font><br>
Example: <font size="2" face="Courier New, Courier, mono">Rotation
= 90</font></p>
<p align="left"><strong>20. Bounds</strong> - set the 3D
boundaries of this building, which is only used if loading
multiple buildings, and if this building is not the first
(primary) building. If both Y values are 0, the Y values are set
to be unlimited. See the Load command in the Buildings section
for more information.<br>
Syntax: <font size="2" face="Courier New, Courier, mono">Bounds
= <em>MinX, MinY, MinZ, MaxX, MaxY, MaxZ</em></font><br>
Example: <font size="2" face="Courier New, Courier, mono">Bounds
= -100, 0, -100, 100, 0, 100</font></p>
<p align="left"> </p>
<p align="left"><strong><font size="+1"><a name="Textures"></a>4.
The <em>Textures</em> Section</font></strong></p>
<p align="left">The Textures section loads textures into the
simulation and assigns names to them, for use in the rest of the
sections. The section starts with this header:<br>
<font size="2" face="Courier New, Courier, mono"><Textures></font></p>
<p align="left">and ends with this footer:<br>
<font size="2" face="Courier New, Courier, mono"><EndTextures></font></p>
<p align="left"><strong>1. Load</strong> - loads a texture<br>
Syntax: <font size="2" face="Courier New, Courier, mono">Load <em>filename</em>,
<em>name</em>, <em>tile_x</em>, <em>tile_y[, force</em></font>]<br>
Example: <font size="2" face="Courier New, Courier, mono">Load
data\brick1.jpg, Brick, 1, 1</font></p>
<p align="left">This example will load the file brick.jpg and name
it Brick. The values <em>tile_x</em> and <em>tile_y</em> are
per-texture multipliers. For example, if you set <em>tile_x</em>
to 2, and you specify a texture width (tw) of 2 during an <em>AddFloor</em>
command later, the tiling value will be 4 (2 times 2), and the
texture will be repeated 4 times horizontally. The <em>force</em>
value is optional, and if set to false, autosizing will always
be disabled for this texture; if set to true, autosizing will
always be enabled.</p>
<p align="left"><strong>2. LoadRange</strong> - loads a numeric
range of textures, and the current number is available in the <em>number</em>
variable (<font size="2" face="Courier New, Courier, mono">%number%</font>)<br>
Syntax: <font size="2" face="Courier New, Courier, mono">LoadRange
<em>startnumber</em>, <em>endnumber</em>, <em>filename</em>,
<em>name</em>, <em>tile_x</em>, <em>tile_y[, force] </em></font><br>
Example: <font size="2" face="Courier New, Courier, mono">LoadRange
2, 138, data\floorindicators\%number%.jpg, Button%number%, 1,
1</font></p>
<p align="left">This example will load the file 2.jpg and name it
Button2, 3.jpg as Button3, and so on. The values <em>tile_x</em>
and <em>tile_y</em> are per-texture multipliers. For example,
if you set <em>tile_x</em> to 2, and you specify a texture
width (tw) of 2 during an <em>AddFloor</em> command later, the
tiling value will be 4 (2 times 2), and the texture will be
repeated 4 times horizontally. The <em>force</em> value is
optional, and if set to false, autosizing will always be
disabled for this texture; if set to true, autosizing will
always be enabled.</p>
<p style="text-align:left;margin-left:0;margin-right:auto;"><strong>3.
LoadAnimated</strong> - loads a set of textures to use as a
single animated texture<br>
Syntax: <font size="2" face="Courier New, Courier, mono">LoadAnimated
<em>filename1, filename2, ..., name, duration, tile_x,
tile_y[, force]<br>
</em></font>Example: <font size="2" face="Courier New,
Courier, mono">LoadAnimated data/pic1.jpg, data/pic2.jpg,
data/pic3.jpg, myanimation, 2, 1, 1</font></p>
<p style="text-align:left;margin-left:0;margin-right:auto;">This
example will load the files pic1.jpg, pic2.jpg and pic3.jpg and
associate them with the texture material "myanimation". When
"myanimation" is used, those three images will automatically be
displayed in order, in a loop. <em>Duration</em> refers to the
length of the animation in seconds. The values <em>tile_x</em>
and <em>tile_y</em> are per-texture multipliers. For example,
if you set <em>tile_x</em> to 2, and you specify a texture
width (tw) of 2 during an <em>AddFloor</em> command later, the
tiling value will be 4 (2 times 2), and the texture will be
repeated 4 times horizontally. The <em>force</em> value is
optional, and if set to false, autosizing will always be
disabled for this texture; if set to true, autosizing will
always be enabled.</p>
<p style="text-align:left;margin-left:0;margin-right:auto;"><strong>4.
LoadAlphaBlend</strong> - loads a texture with a specular mask
texture and blending texture, used to make things like
reflection effects<br>
Syntax: <font size="2" face="Courier New, Courier, mono">LoadAlphaBlend
<em>filename, specular_filename, blend_filename, name,
spherical, tile_x, tile_y[, force]<br>
</em></font>Example: <font size="2" face="Courier New,
Courier, mono">LoadAlphaBlend data/windows.jpg,
data/windows_spec.png, data/sky.jpg, mywindows, true, 1, 1<br>
</font>This example will load the texture windows.jpg normally,
and will load windows_spec.png as a specular mask (which needs
to be a file that contains an alpha blended image that is used
to determine how the blending texture applies to the original
texture), and loads a texture to blend as sky.jpg (see
Skyscraper's data folder for examples of this). The <em>spherical</em>
parameter determines if the texture is spherically mapped (true)
or planar mapped (false). The values <em>tile_x</em> and <em>tile_y</em>
are per-texture multipliers. For example, if you set <em>tile_x</em>
to 2, and you specify a texture width (tw) of 2 during an <em>AddFloor</em>
command later, the tiling value will be 4 (2 times 2), and the
texture will be repeated 4 times horizontally. The <em>force</em>
value is optional, and if set to false, autosizing will always
be disabled for this texture; if set to true, autosizing will
always be enabled.</p>
<p style="text-align:left;margin-left:0;margin-right:auto;"><strong>5.
LoadMaterial</strong> - loads a custom OGRE material, used for
advanced/specific texture definitions<br>
Syntax: <font size="2" face="Courier New, Courier, mono">LoadMaterial
<em>material_name, name, </em><em><em>tile_x, tile_y[, force]<br>
</em></em></font>Example: <font size="2" face="Courier New,
Courier, mono">LoadMaterial testmat, mycustommaterial, 1, 1<br>
</font>Material definitions (and their associated textures) are
stored in Skyscraper's data/materials folder, and are all
automatically loaded on startup. The material definitions (the
example being testmat.material) contain a material name along
with the texture processing parameters. The material name
specified in this command needs to match the one in the material
definition you want to use; the example file is named "testmat".
<em>Name</em> is the standard texture name you want to map it
to, to use with other commands. The other commands are the same
as in previous commands. For more information on how to make
material definition scripts, see the <a
href="http://www.ogre3d.org/docs/manual/manual_14.html#Material-Scripts">OGRE
manual's
"Material Scripts" section</a>.</p>
<p align="left"><strong>6. AddText</strong> - draws text onto a
texture - this only creates a new texture during runtime (in
memory), and all changes are lost when the application shuts
down<br>
Syntax: <font size="2" face="Courier New, Courier, mono">AddText
<em>texture_name, name, font_filename, font_size, text, x1,
y1, x2, y2, h_align, v_align, ColorR, ColorG, ColorB[, force</em></font><em>]<br>
</em>Example: <font size="2" face="Courier New, Courier, mono">AddText
Black, Button100, nimbus_sans.ttf, 47, 100, -1, -1, -1, -1,
center, center, 255, 255, 255</font></p>
<p align="left">With this command, <em>texture_name</em> is the
name of the previously loaded texture to draw text onto (loaded
with either Load or LoadRange). <em>Name</em> is the name to
call this new texture. <em>Font_filename</em> is the filename
of the font to use - fonts are in Skyscraper's data/fonts
directory. <em>X1</em>, <em>y1</em>, <em>x2</em>, and <em>y2</em>
are coordinate values mainly used to position the text in a
boxed area, with the position of 0, 0 (x 0, y 0) being on the
top left.. If any value is -1, the dimension of the texture will
be used (so in this example, the loaded texture has a size of
128x128 pixels, and so the values are 0, 0, 128, 128). This will
place the text in the center of the texture image, but to
position it elsewhere, specify the pixel box to place it in. <em>H_align</em>
and <em>v_align</em> determine the alignment of the text - for
h_align, it can either be "left", "right" or "center", and for
v_align either "top", "bottom" or "center". <em>ColorR</em>, <em>ColorG</em>
and <em>ColorB</em> determine the color of the text, and the
values range from 0 to 255. If all values are 255, the text is
white, and if all values are 0, then it's black. The <em>force</em>
value is optional, and if set to false, autosizing will always
be disabled for this texture; if set to true, autosizing will
always be enabled.</p>
<p align="left"><strong>7. AddTextRange</strong> - similar to
LoadRange, but draws text onto a texture<br>
Syntax: <font size="2" face="Courier New, Courier, mono">AddText