Skyscraper Building Design Guide

3. The Globals Section

The Globals 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:
<Globals>

and ends with this footer:
<EndGlobals>

Parameters are placed between those two markers, and look like this:
Parameter = value

Example:
Name = Triton Center

Parameters (all are optional):

1. Name - building name
Example: Name = My Building

2. Designer - name of building's designer
Designer = Me

3. Location - location of the building
Location = 100 Main Street

4. Description - Brief description of the building
Description = A really average building

5. Version - Version of the building (can be text)
Version = 1

6. CameraFloor - camera's starting floor, starting with 0 (like Floors command) - default is 0
CameraFloor = 0

7. CameraPosition - camera's starting position in X (left/right) and Z (forward/backward) feet coordinates - default is "0, 0"
Syntax: CameraPosition = X, Z
CameraPosition = 0, -10

8. CameraDirection - 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.
CameraDirection = 0, 10, 28.8

9. CameraRotation - 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.
Syntax: CameraRotation = X, Y, Z
CameraRotation = 0, 90, 0

10. Sky - 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".
Sky = noon

11. DynamicSky - 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".
DynamicSky = RainWind

Available sky types in data/caelum/sky.os file:
DefaultBase
DefaultSky
Cloudy
Overcast
BigPuffyStars
BigPuffyStarsWithFogComposer
MidnightSun
Eclipse
FogSky
RainWind
RainUp
ShadowDebug
HugeAmbientFactor
BasicCloud
OverrideCloud
CloudMesh
CloudFade
SkyDomeOverrideHazeTest
GroundFogNoise
SandStormTest

12. InterfloorOnTop - 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.
InterfloorOnTop = true

13. Collisions - enables/disables collisions (default is true)
Collisions = false

14. Gravity - enables/disables gravity (default is true)
Gravity = false

15. Coordinates - set latitude and longitude of building (for sky system)
Coordinates = 41.883, -87.629

16. DateTime - set UTC date/time on startup (in Julian value), for sky system, or set to "now" to use the current system time
DateTime = 2457197.1254
DateTime = now

17. TimeScale - sets the time multiplier for the sky system. The default is 25. Set to 1 for real-time.
TimeScale = 1

18. Position - set the 3D position of this building, used when loading multiple buildings. See the Load command in the Buildings section for more information.
Syntax: Position = X, Y, Z
Example: Position = 100, 0, 100

19. Rotation - 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.
Syntax: Rotation = value
Example: Rotation = 90

20. Bounds - 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.
Syntax: Bounds = MinX, MinY, MinZ, MaxX, MaxY, MaxZ
Example: Bounds = -100, 0, -100, 100, 0, 100

4. The Textures Section

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:
<Textures>

and ends with this footer:
<EndTextures>

1. Load - loads a texture
Syntax: Load filename, name, tile_x, tile_y[, force]
Example: Load data\brick1.jpg, Brick, 1, 1

This example will load the file brick.jpg and name it Brick. The values tile_x and tile_y are per-texture multipliers. For example, if you set tile_x to 2, and you specify a texture width (tw) of 2 during an AddFloor command later, the tiling value will be 4 (2 times 2), and the texture will be repeated 4 times horizontally. The force 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.

2. LoadRange - loads a numeric range of textures, and the current number is available in the number variable (%number%)
Syntax: LoadRange startnumber, endnumber, filename, name, tile_x, tile_y[, force]
Example: LoadRange 2, 138, data\floorindicators\%number%.jpg, Button%number%, 1, 1

This example will load the file 2.jpg and name it Button2, 3.jpg as Button3, and so on. The values tile_x and tile_y are per-texture multipliers. For example, if you set tile_x to 2, and you specify a texture width (tw) of 2 during an AddFloor command later, the tiling value will be 4 (2 times 2), and the texture will be repeated 4 times horizontally. The force 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.

3. LoadAnimated - loads a set of textures to use as a single animated texture
Syntax: LoadAnimated filename1, filename2, ..., name, duration, tile_x, tile_y[, force]
Example: LoadAnimated data/pic1.jpg, data/pic2.jpg, data/pic3.jpg, myanimation, 2, 1, 1

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. Duration refers to the length of the animation in seconds. The values tile_x and tile_y are per-texture multipliers. For example, if you set tile_x to 2, and you specify a texture width (tw) of 2 during an AddFloor command later, the tiling value will be 4 (2 times 2), and the texture will be repeated 4 times horizontally. The force 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.

4. LoadAlphaBlend - loads a texture with a specular mask texture and blending texture, used to make things like reflection effects
Syntax: LoadAlphaBlend filename, specular_filename, blend_filename, name, spherical, tile_x, tile_y[, force]
Example: LoadAlphaBlend data/windows.jpg, data/windows_spec.png, data/sky.jpg, mywindows, true, 1, 1
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 spherical parameter determines if the texture is spherically mapped (true) or planar mapped (false). The values tile_x and tile_y are per-texture multipliers. For example, if you set tile_x to 2, and you specify a texture width (tw) of 2 during an AddFloor command later, the tiling value will be 4 (2 times 2), and the texture will be repeated 4 times horizontally. The force 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.

5. LoadMaterial - loads a custom OGRE material, used for advanced/specific texture definitions
Syntax: LoadMaterial material_name, name, tile_x, tile_y[, force]
Example: LoadMaterial testmat, mycustommaterial, 1, 1
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". Name 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 OGRE manual's "Material Scripts" section.

6. AddText - 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
Syntax: AddText texture_name, name, font_filename, font_size, text, x1, y1, x2, y2, h_align, v_align, ColorR, ColorG, ColorB[, force]
Example: AddText Black, Button100, nimbus_sans.ttf, 47, 100, -1, -1, -1, -1, center, center, 255, 255, 255

With this command, texture_name is the name of the previously loaded texture to draw text onto (loaded with either Load or LoadRange). Name is the name to call this new texture. Font_filename is the filename of the font to use - fonts are in Skyscraper's data/fonts directory. X1, y1, x2, and y2 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. H_align and v_align 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". ColorR, ColorG and ColorB 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 force 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.

7. AddTextRange - similar to LoadRange, but draws text onto a texture
Syntax: AddText startnumber, endnumber, texture_name, name, font_filename, font_size, text, x1, y1, x2, y2, h_align, v_align, ColorR, ColorG, ColorB[, force]
Example: AddText 1, 100, Black, Button%number%, nimbus_sans.ttf, 47, %number%, -1, -1, -1, -1, center, center, 255, 255, 255

8. LoadCropped - loads a cropped image.
Syntax: LoadCropped filename, name, x, y, width, height, tile_x, tile_y[, force]
Example: LoadCropped data\brick1.jpg, Brick2, 10, 10, 20, 20, 1, 1

This command is similar to the Load command, but loads only a portion of an image. In the above example, the command loads the file data\brick1.jpg as "Brick2", but only loads the portion of the image starting at pixel 10, 10, with a width of 20 pixels and a heigth of 20 pixels. Pixel 0, 0 is on the top left of the image. The force 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.

9. AddOverlay - draws an image on top of another image
Syntax: AddOverlay texture_name, overlay_texture_name, name, x, y, width, height, tile_x, tile_y[, force]
Example: AddOverlay Brick1, Brick2, NewBrick, 25, 25, 50, 50, 1, 1

This command allows multiple textures to be combined into a single texture, by drawing one on top of the other. Texture_name specifies the original source texture name to use (all textures must be loaded beforehand), overlay_texture_name specifies the texture to draw on top of the source texture, and name specifies the name of the new texture. X and Y determine the position to place the top-left of the new image at (since position 0, 0 is the top left of the image), and width and height determine the size in pixels of the overlay texture. In the above example, the "Brick2" texture is drawn on top of the "Brick1" texture, starting at pixel position 25, 25, with a width of 50 and a height of 50. The resulting texture is called "NewBrick". The force 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.

10. Rotate - sets a texture's rotation to a set amount. This can be used with other texture modifiers.
Syntax: Rotate name, angle
Example: Rotate Brick1, 30

This command sets the texture's rotation value. In the example, the Brick1 texture's rotation is set to 30 degrees (clockwise).

11. RotateAnim - applies rotation animation to a texture. This can be used with other texture modifiers.
Syntax: RotateAnim name, speed
Example: RotateAnim Brick1, 0.2

This command sets the texture's animated rotation value. Speed is in rotations per second. In the example, the Brick1 texture's rotation animation is set to 0.2 rotations per second.

12. Scroll - set's a texture's fixed scrolling value. This can be used with other texture modifiers.
Syntax: Scroll name, x_offset, y_offset
Example: Scroll Brick1, 0.5, 0.5

This command sets the texture's scrolling value. In the example, the Brick1 texture is shifted to the right halfway, and shifted up halfway.

13. ScrollAnim - applies scrolling animation to a texture. This can be used with other texture modifiers.
Syntax: ScrollAnim name, x_speed, y_speed
Example: ScrollAnim Brick1, 1, 1

The speed values are the number of full scrolls per second. In the example, the Brick1 texture will scroll to the right once per second, and up once per second.

14. Scale - sets a texture's scaling factor. This can be used with other texture modifiers.
Syntax: Scale name, x_scale, y_scale
Example: Scale Brick1, 30

In the example, the Brick1 texture is scaled to half the size, in both width and height.

15. Transform - sets an advanced transformation method on the texture. This can be used with other texture modifiers, and also can be used multiple times to create multiple transformations.
Syntax: Transform name, type, wave_type, base, frequency, phase, amplitude
Example: Transform Brick1, rotate, sine, 0.2, 0.2, 0.1, 1.0

This command applies an advanced transformation method on the texture. Type is the animation type modified, and can either be scroll_x, scroll_y, rotate, scale_x, or scale_y. Wave_type defines the type of waveform applied to the transformation, which creates a variable speed of the animation. The values are sine (a typical sine wave which smoothly loops between min and max values), triangle (an angled wave which increases & decreases at constant speed, changing instantly at the extremes), square (max for half the wavelength, min for the rest with instant transition between), sawtooth (gradual steady increase from min to max over the period with an instant return to min at the end), inverse_sawtooth (gradual steady decrease from max to min over the period, with an instant return to max at the end), or pwm (Pulse Width Modulation; like square, except the high to low transition is controlled by duty cycle). Base is the base value of the wave (base value, the minimum if amplitude > 0, the maximum if amplitude < 0), frequency is the number of wave iterations per second (speed), phase is the offset of the wave start, and amplitude is the size of the wave.

5. The Floor Sections

The Floor section can either be defined as a single floor, using the Floor name, or as a range of floors, using the Floors name.
For a single floor, the section would start with this:
<Floor number>
and end with this:
<EndFloor>
For example, a floor section for a lobby would use this:
<Floor 0>

For multiple floors, the section would start with this:
<Floors start to finish>
and end with this:
<EndFloors>
For example, to work with floors 5-10, you would type:
<Floors 5 to 10>
Or to work with basement floors -1 to -5, you would type:
<Floors -1 to -5>

Ranges in this can be specified in either direction. Floors above ground start with 0 (so a 15-story building would have floors 0-14). Also, floors must be made in the proper order: basement levels must be created in descending order (-1, -2, -3 etc), and above-ground floors in ascending order (0, 1, 2, etc).
If floor 0 is created first, and then basement levels, floor -1's altitude will be adjusted based on floor 0's altitude; otherwise if floor -1 is created first, it's altitude will be the negative full height.

Variables:

%floor% - contains the current floor number
%height% - contains the current floor's ceiling height
%interfloorheight% - contains the current floor's interfloor height (spacing between floors)
%fullheight% - contains the current floor's total height, including the interfloor height
%base% - if the InterfloorOnTop parameter in the Globals section is set to 'false' (the default), then Base refers to the floor's altitude plus interfloor height (slab height); otherwise it's the floor's altitude
%floorname% - the floor's name
%floorid% - the floor's ID
%floortype% - the floor's type
%description% - the floor's description

Parameters:

1. Name - the name of the current floor, required
Example: Name = Floor %floor%

2. ID - the floor indicator name for the current floor, such as L (for Lobby), LL (lower level), M (Mezzanine), etc. This is also used to determine what texture should be loaded for the elevator floor indicators and floor signs. The texture name would be "Button[ID]" - so if the ID is 10, the texture name would be "Button10".
ID = %floor%

3. Type - the type of floor the current floor is. The types are still being defined, but the currently used ones are Basement, Lobby, Mezzanine, Conference, Office, Service, Skylobby, Hotel, Apartment, Condominium, Restaurant, Observatory, Recreation, Ballroom, Communications, and Roof. (Required)
Type = Office

4. Description - description of the current floor, optional
Description = Offices

5. Height - the floor-to-ceiling height of the current floor, required
Height = 9.5

6. InterfloorHeight - the height in feet of the space between floors (below each floor), starting at the floor's altitude, and ending right below the level's floor; required.
InterfloorHeight = 2.24

7. Altitude - this parameter is optional and is only recommended if the first level has an interfloor area that needs to be below ground. If this parameter is not used, the altitude will be calculated automatically.
Altitude = -2.24

8. Group - group floors together. This is a list of comma-separated floor numbers (or a range specified with the - symbol) that should be enabled along with this floor when the user arrives at this floor. For example, if a 2-story room has a balcony, and the room base and balcony are separate floors, you would specify the other floor's number in this parameter.
Examples:
Group = 5
Group = 4, 5
Group = 4 - 10

Commands:

1. Exit - exits the current floor section

2. AddFloor - adds a textured floor with the specified dimensions to the current floor/level
Syntax: AddFloor name, texturename, thickness, x1, z1, x2, z2, voffset1, voffset2, reverse_axis, texture_direction, tw, th, isexternal
Example: AddFloor My Floor, Brick, 0.5, -10, -10, 10, 10, 0, 0, False, False, 0, 0, False

Voffset1 and voffset2 are the height in feet above the current floor's base; tw and th are to size/tile the texture (0 lets the app autosize them), and isexternal determines if the floor is part of the building's external framework, or is part of the current floor (is either True or False). Name is a user-defined name for the object. The reverse_axis parameter reverses the axis that the difference in altitude/voffset for floors corresponds to. If this is false, and the altitude values are different, the floor will angle upward/downward along the Z axis (front/back), and if set to true, the floor will angle along the X axis (left/right). If texture_direction is false, the texture will be mapped horizontally on the floor; if true, it'll be mapped vertically. If isexternal is true, the voffset values are relative of the floor's altitude, not base.

3. AddWall - adds a textured wall with the specified dimensions to the current floor/level
Syntax: AddWall name, texturename, thickness, x1, z1, x2, z2, height1, height2, voffset1, voffset2, tw, th, isexternal
Example: AddWall My Wall, Brick, 0.5, -10, -10, 10, 10, 10, 10, 0, 0, 0, 0, False

Height1 is the wall height in feet at the first coordinate set (x1 and z1), and height2 is for the second set (x2, and z2). Voffset1 is the vertical offset in feet (from the floor's base) for the first coordinate set, and voffset2 is for the second set. Tw and th are the texture sizing/tiling multipliers, and isexternal determines if the wall is part of the building's external framework (true) or if it's part of the current floor (false). If isexternal is true, the voffset values are relative of the floor's altitude, not base.

4. AddInterfloorFloor - adds a textured floor below the floor of the current floor/level
Syntax: AddInterfloorFloor name, texturename, thickness, x1, z1, x2, z2, voffset1, voffset2, reverse_axis, texture_direction, tw, th
Example: AddInterfloorFloor My IFloor, Brick, 0.5, -10, -10, 10, 10, 0, 0, 0, 0

The parameters are the same as the AddFloor command, except the voffset values are the height offset in feet above the current floor's altitude, not above the base.

5. AddInterfloorWall - adds a textured wall below the floor of the current floor/level
Syntax: AddInterfloorWall name, texturename, thickness, x1, z1, x2, z2, height1, height2, voffset1, voffset2, tw, th

The parameters are the same as the AddWall command, and the voffset values are the same as the AddInterfloorFloor command.

6. AddShaftFloor - adds a textured floor to the specified shaft, on the current floor
Syntax: AddShaftFloor number, name, texturename, thickness, x1, z1, x2, z2, voffset1, voffset2, reverse_axis, texture_direction, tw, th
Example: AddShaftFloor 1, My Floor, Brick, 0.5, -10, -10, 10, 10, 0, 0, false, false, 0, 0

The parameters are the same as the AddFloor command, and the number value is the shaft number to use. The x1, z1, x2, and z2 parameters are offsets of the shaft's origin (similar to creating elevator walls and floors)

7. AddShaftWall - adds a textured wall to the specified shaft, on the current floor
Syntax: AddShaftWall number, name, texturename, thickness, x1, z1, x2, z2, height1, height2, voffset1, voffset2, tw, th

The parameters are the same as the AddWall command, and the number value is the shaft number to use. Also, the x1, z1, x2, and z2 parameters are offsets of the shaft's origin (similar to creating elevator walls and floors)

8. AddStairsFloor - adds a textured floor to the specified stairwell, on the current floor
Syntax: AddStairsFloor number, name, texturename, thickness, x1, z1, x2, z2, voffset1, voffset2, reverse_axis, texture_direction, tw, th
Example: AddStairsFloor 1, My Floor, Brick, 0.5, -10, -10, 10, 10, 0, 0, false, false, 0, 0

The parameters are the same as the AddFloor command, and the number value is the stairwell number to use

9. AddStairsWall - adds a textured wall to the specified stairwell, on the current floor
Syntax: AddStairsWall number, name, texturename, thickness, x1, z1, x2, z2, height1, height2, voffset1, voffset2, tw, th

The parameters are the same as the AddWall command, and the number value is the stairwell number to use. Also, the x1, z1, x2, and z2 parameters are offsets of the stairwell's origin (similar to creating elevator walls and floors)

10. ColumnWallBox - creates 4 walls (box) at the specified coordinate locations, as part of the current floor's columnframe mesh
Syntax: ColumnWallBox name, texturename, x1, x2, z1, z2, height, voffset, tw, th, inside, outside, top, bottom
Example: ColumnWallBox My Box, Brick, -10, 10, -10, 10, 15, 0, 0, 0, true, true, true, true

For parameter information, see the CreateWallBox command above. In this command, the default voffset is the floor's altitude.

11. ColumnWallBox2 - creates 4 walls (box) at a specified central location, as part of the current floor's columnframe mesh
Syntax: ColumnWallBox2 name, texturename, centerx, centerz, widthx, lengthz, height, voffset, tw, th, inside, outside, top, bottom
Example: ColumnWallBox2 My Box, Brick, 0, 0, 10, 10, 15, 0, 0, 0, false, true, false, false

For parameter information, see the CreateWallBox2 command above. In this command, the default voffset is the floor's altitude.

12. CallButtonElevators - comma-separated list of elevators the next created call button set will work with (this must be specified before CreateCallButtons)
Example: CallButtonElevators = 1, 2, 3, 4

13. CreateCallButtons - creates a call button set
Syntax: CreateCallButtons SoundUp, SoundDown, BackTexture, UpButtonTexture, UpButtonTexture_Lit, DownButtonTexture, DownButtonTexture_Lit, CenterX, CenterZ, voffset, direction, BackWidth, BackHeight, ShowBack, tw, th
Example: CreateCallButtons switch.wav, switch.wav, Marble, CallButtonsUp, CallButtonsUpLit, CallButtonsDown, CallButtonsDownLit, -10, 0, 4, right, 0.5, 1, true, 1, 1

SoundUp is the filename of the sound to play when the up call button is pressed

SoundDown is the filename of the sound to play when the down call button is pressed

BackTexture is the texture of the wall plate behind the buttons

UpButtonTexture and DownButtonTexture are the textures used for the buttons themselves (unlit). UpButtonTexture_Lit and DownButtonTexture_Lit specify the lit button textures.

CenterX and CenterZ are the central location of the call button set object

voffset is the altitude offset that the object is above each floor

direction determines the direction the call buttons face:
'front' means they face towards the front of the building
'back' means they face towards the back of the building
'left' means they face left
'right' means they face right

BackWidth and BackHeight are the width and height of the wall plate

ShowBack determines if the wall plate should be shown, and is either true or false

tw and th are the texture scaling for the wall plate.

The up and down buttons will be automatically created based on the combined range of the elevators specified with the CallButtonElevators command (above).

Actions are automatically created for call buttons, and here's available action command names that can be used for custom controls:

Off (no action)
Up (perform up call)
Down (perform down call)
PressUp (press Up call button)
PressDown (press Down call button)
FireOff (set fire service phase 1 to Off for all elevators serviced by this call button)
FireOn (set fire service phase 1 to On for all elevators serviced by this call button)
FireBypass (set fire service phase 1 to Bypass for all elevators service by this call button)

14. AddStairs - creates a custom staircase at the specified location.
Syntax: AddStairs number, name, riser_texture, tread_texture, direction, CenterX, CenterZ, width, risersize, treadsize, num_stairs, voffset, tw, th
Example: AddStairs 1, TestStairs, Brick, left, 10, 15, 5, 0.5, 0.5, 10, 0, 0, 0

The direction parameter specifies the direction the staircase faces (where the bottom step is), and so if a staircase goes up from left to right, the direction would be left. Width specifies the step width; risersize specifies the height of each step riser (vertical portion); treadsize specifies the length of each step tread/run (horizontal portion); num_stairs specifies the total number of steps to create (including the above landing platform, but not including the base platform). To calculate the length of the staircase, multiply (num_stairs - 1) with treadsize; in the above example, that would be 9 * 0.5. To determine the height of the staircase, multiply num_stairs with risersize. Note that the tread of the top step is not drawn (the top step is the landing platform); therefore for a staircase containing 10 steps, the total staircase width would be comprised of 9 treads (which is why the length calculation used num_stairs minus 1).

15. AddDoor - adds a textured door in the specified location, and performs a wall cut on that area (this must be called after the associated wall is created)
Syntax: AddDoor opensound, closesound, open, texturename, thickness, direction, speed, CenterX, CenterZ, width, height, voffset, tw, th
Example: AddDoor , , False, DoorTexture, 0.2, 1, 0, -8.5, 0, 3.5, 8, 0, 1, 1

Direction specifies the direction the door faces (the side in which the handle is on the left) and also the direction it opens. These are the values:
1 - faces left, opens left
2 - faces left, opens right
3 - faces right, opens right
4 - faces right, opens left
5 - faces front, opens front
6 - faces front, opens back
7 - faces back, opens back
8 - faces back, opens front

The default door speed is 75; you can also specify 0 for the speed to use the system default. The open parameter determines if the door should be opened on start; default is false. Leave the sound fields blank for no sounds to be played.

16. AddStairsDoor - adds a textured door for the specified stairwell, in a location relative to the stairwell's center. This also performs a wall cut on that area (this must be called after the associated wall is created)
Syntax: AddStairsDoor number, opensound, closesound, open, texturename, thickness, direction, speed, CenterX, CenterZ, width, height, voffset, tw, th

Number specifies the stairwell number. Direction specifies the direction the door faces and also the direction it opens. For values of this, look at the AddDoor command above. Leave the sound fields blank for no sounds to be played.

17. AddShaftStdDoor - adds a standard textured door for the specified shaft, in a location relative to the shaft's center. This also performs a wall cut on that area (this must be called after the associated wall is created). This shouldn't be confused with the AddShaftDoor command, which creates elevator shaft doors.
Syntax: AddShaftStdDoor number, opensound, closesound, open, texturename, thickness, direction, speed, CenterX, CenterZ, width, height, voffset, tw, th

Number specifies the shaft number. Direction specifies the direction the door faces and also the direction it opens. For values of this, look at the AddDoor command above. Leave the sound fields blank for no sounds to be played.

18. AddExternalDoor - same as the AddDoor command, but creates an external (global) door that is always visible. With this command, the voffset parameter is relative of the floor's altitude, not base.
Syntax: AddExternalDoor opensound, closesound, open, texturename, thickness, direction, speed, CenterX, CenterZ, width, height, voffset, tw, th
Example: AddExternalDoor , , False, DoorTexture, 0.2, 1, 0, -8.5, 0, 3.5, 8, 0, 1, 1

19. AddDirectionalIndicator - creates a single elevator directional indicator/lantern on the current floor (similar to the CreateCallButtons command)
Syntax: AddDirectionalIndicator Elevator:Car, Relative, ActiveDirection, Single, Vertical, BackTexture, UpTexture, UpTextureLit, DownTexture, DownTextureLit, CenterX, CenterZ, voffset, direction, BackWidth, BackHeight, ShowBack, tw, th
Example: AddDirectionalIndicator 1, true, false, false, true, Metal, UpLight, UpLightOn, DownLight, DownLightOn, -3, -4.162, 6, front, 0.5, 1, true, 0, 0

This command will create a directional indicator on the current floor (if ActiveDirection is false, then it'll only create it if the elevator serves that floor). It'll also automatically create the up and down lights depending on the floor.

Elevator:Car specifies the elevator and car to create the indicators for. The car value is optional, and if left out, either the car will be used that services the floor, or the first car will be used. For example, values can be "1" for Elevator 1 (uses default car or Car 1), or "1:1" for Elevator 1 Car 1.

Relative determines if the X and Z coordinates are relative to the elevator's origin (center) or not.

ActiveDirection determines if the indicator should continuously display the active elevator direction (true), or if it should show the elevator's direction for the current call (false, default)

Single determines if a single indicator light should be created instead of two. If this is true, the unlit texture is specified in UpLight, and the DownLight value is ignored.

Vertical determines if the two lights should be vertically separated (true), or horizontally separated (false)

BackTexture is the texture of the wall plate behind the lights

UpTexture and DownTexture are the textures used for the lights themselves, and the "Lit" texures are the ones to show when the light is on. DownTexture is ignored if Single is true.

CenterX and CenterZ are the central location of the indicators

voffset is the altitude offset that the object is above each floor

direction determines the direction the indicators face:
'front' means they face towards the front of the building
'back' means they face towards the back of the building
'left' means they face left
'right' means they face right

BackWidth and BackHeight are the width and height of the wall plate

ShowBack determines if the wall plate should be shown, and is either true or false

tw and th are the texture scaling for the wall plate.

20. AddShaftDoor - creates shaft elevator doors on the current floor only
Syntax: AddShaftDoor elevator:car, number, lefttexture, righttexture, thickness, CenterX, CenterZ, voffset, tw, th
Syntax (with old SetShaftDoors command): AddShaftDoor elevator, number, lefttexture, righttexture, tw, th

The AddShaftDoor command creates working shaft elevator doors on the current floor only - the other command, AddShaftDoors (in the elevator section) creates all shaft doors in a single command. This command is useful for specifying different textures for shaft doors depending on the floor, and also for only creating shaft doors on one side if an elevator serves a specific floor. The SetShaftDoors command in the elevator section must be used before using this command. Parameters such as width, height, and direction are taken from the AddDoors command (so the regular elevator doors need to be created first). The voffset parameter allows you to create shaft doors at a different vertical position than the base of the floor, and the elevator will automatically stop according to the shaft door's voffset for that floor. These doors should be moved slightly away from the elevator car doors (to separate them both). Also, this command cuts any shaft walls that are within the door area (and so this must be called after the shaft walls are created). Number specifies the number of the door to create (related to the Doors command) - if the elevator only has one door, or if the Doors command was not used, specify 1 here. The Elevator:Car parameter specifies both the elevator and optionally elevator car to use (see the AddDirectionalIndicator command for more information).

21. AddFloorIndicator - creates a floor indicator associated with a specific elevator
Syntax: AddFloorIndicator elevator:car, relative, texture_prefix, blank_texture, direction, CenterX, CenterZ, width, height, voffset

The AddFloorIndicator command creates a floor indicator at the position specified by CenterX and CenterZ, associated with the elevator and car specified by elevator:car (see the AddDirectionalIndicator command). Direction is the direction the indicator faces, and can be either "left", "right", "front" or "back". Relative determines if the CenterX and CenterZ values are relative of the elevator's center or not. This command can be given multiple times to create multiple indicators. Texture_prefix is the base name of the texture to load when displaying a floor ID; for example if the indicator is on floor 3, and you specify a prefix of "Button", it'll load the "Button3" texture. Blank_texture specifies a texture to be used when the indicator is blank.

22. Cut - performs a manual box cut on an area within the current floor
Syntax: Cut x1, y1, z1, x2, y2, z2, cutwalls, cutfloors
Example: Cut -5, -5, -5, 5, 5, 5, false, true

The x, y and z values specify the start and end coordinates of the box cut. The Y values are relative to the current floor's altitude. If cutwalls is true, the function will cut walls; if cutfloors is true, it'll cut floors.

23. CutAll - performs a manual box cut on all objects associated with the current floor (the level itself, interfloor, shafts, stairs and external)
Syntax: CutAll x1, y1, z1, x2, y2, z2, cutwalls, cutfloors
Example: CutAll -5, -5, -5, 5, 5, 5, false, true

24. AddFillerWalls - helper function to add fillers around a door's cut location. When a door is created, the wall in it's location is cut to provide space; after the cut, the sides are open (if the wall has thickness) - this creates a covering wall on each side and a floor above the door frame to fill the area.
Syntax: AddFillerWalls texture, thickness, CenterX, CenterZ, width, height, voffset, direction, tw, th, isexternal
Example: AddFillerWalls ConnectionWall, 0.5, -10, 0, 3.5, 8, 0, true, 0, 0, false

The parameters in this function are similar to the related door's parameters. Direction is either true if the door faces the front/back (width is along the X axis), or false if the door faces left/right (width is along the Z axis).
The isexternal parameter is the same as with the AddWall command, and if it is true, the voffset value is relative of the floor's altitude, not base.

25. AddSound - creates a user-defined sound at the specified position
Syntax: AddSound name, filename, x, y, z, loop[, volume, speed, min_distance, max_distance, doppler_level, cone_inside_angle, cone_outside_angle, cone_outside_volume, direction_x, direction_y, direction_z]
Example 1: AddSound MySound, sound.wav, 10, 100, 5, true
Example 2: AddSound MySound, sound.wav, 10, 100, 5, true, 1, 100, 1, -1, 0, 360, 360, 1, 0, 0, 0

For information on the parameters, see the AddSound command in the Global Commands section. The only difference here is that the Y value is relative of the floor's base (altitude plus interfloor height). Loop specifies if the sound should loop and play on startup.

26. AddShaftDoorComponent - creates a single shaft door component, used for creating custom door styles
Syntax: AddShaftDoorComponent elevator:car, number, name, texture, sidetexture, thickness, direction, openspeed, closespeed, x1, z1, x2, z2, height, voffset, tw, th, side_tw, side_th

This command is almost identical to the AddDoorComponent command (in the elevator section below - see that for more information), except that it creates shaft doors. Use the FinishShaftDoor command after creating the components. The components don't need to line up with the floor's base; the elevator will automatically stop at the base of the shaft door for each floor. This command replaces the AddShaftDoor command. The Elevator:Car parameter specifies both the elevator and optionally elevator car to use (see the AddDirectionalIndicator command for more information).

27. FinishShaftDoor - finishes shaft door creation - use this after all related AddShaftDoorComponent commands are used, or specify it without the AddShaftDoorComponent commands if you're creating a manual shaft door.
Syntax: FinishShaftDoor elevator:car, number[, door_walls, track_walls]

This command is almost identical to the FinishDoors command (in the elevator section below - see that for more information) except that it's used for finishing a shaft door.

28. AddModel - adds a 3D model to the floor. If a filename is specified, the model's textures/materials must be defined in a separate ".material" file, and a separate collider mesh ".collider" will be loaded. In that situation, if a collider mesh isn't available, a simple box collider will be created. If a filename is not specified, this command will create a new empty model, where it's name can be used as the destobject parameter in other commands (in the related Floor section), and a collider will be automatically created.
Syntax: AddModel name, filename, center, CenterX, CenterY, CenterZ, RotationX, RotationY, RotationZ, MaxRenderDistance, ScaleMultiplier, EnablePhysics, Restitution, Friction, Mass
Example 1: AddModel MyModel, cube.mesh, true, 0, 0, 0, 0, 0, 0, 0, 1, false, 0, 0, 0
Example 2: AddModel MyModel, cube.mesh, true, 0, 0, 0, 0, 0, 0, 0, 1, true, 0.1, 0.5, 0.1
Example 3: AddModel MyModel, , false, 0, 0, 0, 0, 0, 0, 0, 1, true, 0.1, 0.5, 0.1

The Center value is either true or false, and determines if the loaded model should be automatically centered, otherwise the exact mesh positioning in the model file will be used. The CenterY value is relative to the current floor's base. MaxRenderDistance determines the maximum distance in feet that the object will be shown (0 means unlimited). ScaleMultiplier allows you to change the size of the object during the load - for example, set to 2 to double the size. Model files are in the OGRE native mesh format. In the example, the material/texture file is cube.material, and the optional collider mesh file is cube.collider. EnablePhysics enables Bullet physics on the object (physics will only work if you don't provide a collider mesh), and Restitution, Friction and Mass determine the physical properties of the object.

29. AddStairsModel - adds a 3D model to the specified stairwell, on the current floor. See the AddModel command above for parameter information.
Syntax: AddStairsModel number, name, filename, center, CenterX, CenterY, CenterZ, RotationX, RotationY, RotationZ, MaxRenderDistance, ScaleMultiplier, EnablePhysics, Restitution, Friction, Mass
Example: AddModel 1, MyModel, cube.mesh, true, 0, 0, 0, 0, 0, 0, 0, 1, false, 0, 0, 0

The CenterY value is relative to the current floor's altitude.

30. AddShaftModel - adds a 3D model to the specified shaft, on the current floor. See the AddModel command above for parameter information.
Syntax: AddShaftModel number, name, filename, center, CenterX, CenterY, CenterZ, RotationX, RotationY, RotationZ, MaxRenderDistance, ScaleMultiplier, EnablePhysics, Restitution, Friction, Mass
Example: AddModel 1, MyModel, cube.mesh, true, 0, 0, 0, 0, 0, 0, 0, 1, false, 0, 0, 0

The CenterY value is relative to the current floor's altitude.

31. AddActionControl - creates a custom control that uses a specific action defined by AddAction.
Syntax: AddActionControl name, sound, direction, centerx, centerz, width, height, voffset, selection_position, action_name(s), texture_name(s)
Example: AddActionControl MyControl, switch.wav, front, -10, 10, 1.5, 1.5, 4, 1, UndoMyAction, MyAction, Touch, TouchLit

AddActionControl command creates an advanced control similar to elevator button panel controls, but assigned to an action created with the AddAction command. The action_name(s) and texture_name(s) parameters allow you to specify a list of actions, and a list of textures to go along with those actions. There needs to be a texture for every action; if you specify 3 actions and only 2 textures, you will get an error. The control starts up in the first action, and switches to the next actions in sequence when it's clicked. Direction is the direction the control itself will face in 3D space (front, left, right, back). Voffset is relative of the floor's base. Leave the sound field blank for no sound to be played. Selection_position is the selection position to start at, which is normally 1.

32. AddShaftActionControl - creates a custom control in a specified shaft that uses a specific action defined by AddAction.
Syntax: AddShaftActionControl number, name, sound, direction, centerx, centerz, width, height, voffset, selection_position, action_name(s), texture_name(s)
Example: AddShaftActionControl 1, MyControl, switch.wav, front, -10, 10, 1.5, 1.5, 4, 1, UndoMyAction, MyAction, Touch, TouchLit

This command creates an advanced control similar to elevator car button panel controls, but assigned to an action created with the AddAction command. The action_name(s) and texture_name(s) parameters allow you to specify a list of actions, and a list of textures to go along with those actions. There needs to be a texture for every action; if you specify 3 actions and only 2 textures, you will get an error. The control starts up in the first action, and switches to the next actions in sequence when it's clicked. Direction is the direction the control itself will face in 3D space (front, left, right, back). Voffset is relative of the floor's base. Leave the sound field blank for no sound to be played. Selection_position is the starting selection position, which is normally 1.

33. AddStairsActionControl - creates a custom control in a specified stairwell that uses a specific action defined by AddAction.
Syntax: AddStairsActionControl number, name, sound, direction, centerx, centerz, width, height, voffset, selection_position, action_name(s), texture_name(s)
Example: AddStairsActionControl 1, MyControl, switch.wav, front, -10, 10, 1.5, 1.5, 4, 1, UndoMyAction, MyAction, Touch, TouchLit

This command creates an advanced control similar to elevator button panel controls, but assigned to an action created with the AddAction command. The action_name(s) and texture_name(s) parameters allow you to specify a list of actions, and a list of textures to go along with those actions. There needs to be a texture for every action; if you specify 3 actions and only 2 textures, you will get an error. The control starts up in the first action, and switches to the next actions in sequence when it's clicked. Direction is the direction the control itself will face in 3D space (front, left, right, back). Voffset is relative of the floor's base. Leave the sound field blank for no sound to be played. Selection_position is the starting selection position, which is normally 1.

34. AddTrigger - creates a trigger that is used to signal an action when the user's camera enters or leaves the defined area.
Syntax: AddTrigger name, sound, start_x, start_y, start_z, end_x, end_y, end_z, action_names(s)
Example: AddTrigger MyTrigger, switch.wav, -30, 0, -30, -20, 10, -20, UndoMyAction, MyAction

AddTrigger creates a trigger similar to action controls (AddActionControl) and elevator car controls. The action_names(s) parameter allows you to specify a list of actions that this trigger will call when the camera enters or exits the area. The trigger starts in the first action, and will switch to each consecutive action when the users enters/leaves. The X, Y and Z parameters specify the 3D box that defines the trigger area. Y is relative of the floor's base. Leave the sound field blank for no sound to be played.

35. AddRevolvingDoor - adds a textured revolving door in the specified location.
Syntax: AddDoor sound, texturename, thickness, clockwise, segments, speed, rotation, CenterX, CenterZ, width, height, voffset, tw, th, external
Example: AddRevolvingDoor , DoorTexture, 0.2, false, 4, 0.2, -8.5, 0, 3.5, 8, 0, 1, 1, false

Clockwise determines the direction the door rotates. Segments determines how many door segments to create (2-4). Leave the sound field blank for no sounds to be played.
Rotation determines the starting rotation of the door.

36. AddEscalator - creates an escalator at the specified location.
Syntax: AddEscalator name, run, speed, sound_file, riser_texture, tread_texture, direction, CenterX, CenterZ, width, risersize, treadsize, num_steps, voffset, tw, th
Example: AddEscalator MyEscalator, 1, 1, 1.0, , Brick, left, 0, -10, 4, 1, 1, 15, 0, 1, 1

The direction parameter specifies the direction the escalator faces (where the bottom step is), and so if an escalator goes up from left to right, the direction would be left. Width specifies the step width; risersize specifies the height of each step riser (vertical portion); treadsize specifies the length of each step tread/run (horizontal portion); num_steps specifies the total number of steps to create. Run specifies the run state, where 1 equals forward, 0 equals stopped, and -1 equals reverse.

Actions are automatically created for escalators, and here's the available actions for custom controls:

Forward (run forward)
Reverse (run in reverse)
Stop (stop)

37. AddMovingWalkway - creates a moving walkway at the specified location. This command is similar to AddEscalator.
Syntax: AddMovingWalkway name, run, speed, sound_file, texture, direction, CenterX, CenterZ, width, treadsize, num_steps, voffset, tw, th
Example: AddMovingWalkway MyWalkway, 1, 1, 1.0, , Brick, left, 0, -10, 4, 1, 15, 0, 1, 1

The direction parameter specifies the direction the walkway faces (where the first step is), and so if a walkway goes from left to right, the direction would be left. Width specifies the step width; treadsize specifies the length of each step tread/run (horizontal portion); num_steps specifies the total number of steps to create. Run specifies the run state, where 1 equals forward, 0 equals stopped, and -1 equals reverse.
Moving walkways use the same action names as Escalator objects, so refer to that object for the action names.

6. The Elevator Section

The Elevator section allows you to create elevators for your building. Elevators are numbered, starting with 1.

Each elevator is created with a single default car, Car 1. Car-specific parameters and commands are listed in the Car section, but can also be specified in this section, if an elevator only has a single car, or if you're referring to Car 1.

The section headers and footers are similar to the ones in the Floor section.
To specify a single elevator, you would type something like:
<Elevator 1>
and end it with:
<EndElevator>

For a range of elevators, you would use something like:
<Elevators 2 to 10>
and end with:
<EndElevators>

When creating a new elevator car, the required values for each are the Speed, Acceleration, Deceleration, AssignedShaft, and ServicedFloors parameters and the CreateElevator command.

Variables:

%elevator% - number of the current elevator

Parameters:

1. Name - sets the name of the elevator
Example: Name = Service Elevator

2. Type - sets the type of the elevator. Available types are "Local" for a standard local passenger elevator (the default), "Express" for an express elevator, "Service" for a service elevator, and "Freight" for a freight elevator.
Example: Type = Express

3. Speed, UpSpeed, DownSpeed - maximum speed of the elevator, for either both up and down movements (Speed), or for each individual movement direction (UpSpeed and DownSpeed), in feet per second
Example: Speed = 20

4a. Acceleration - acceleration speed of the elevator, in feet per second
Example: Acceleration = 0.015

4b. AccelJerk - acceleration jerk rate of the elevator (rate of change of acceleration)
Example: AccelJerk = 1.0

5a. Deceleration - deceleration speed of the elevator, in feet per second
Example: Deceleration = 0.0075

5b. DecelJerk - deceleration jerk rate of the elevator (rate of change of deceleration)
Example: DecelJerk = 1.0

6. AssignedShaft - the shaft number this elevator is in
Example: AssignedShaft = 1

7. MotorStartSound, MotorUpStartSound, MotorDownStartSound - the sound file to play when the elevator motor starts moving/speeds up (sets both directions). Default is elevstart.wav. Leave the filename field blank for no sound. The first command specifies both up and down sounds, while the others are for either upwards movement or downwards movement.
Example: MotorStartSound = start.wav

8. MotorRunSound, MotorUpRunSound, MotorDownRunSound - the sound file to play while the elevator motor is running (sets both directions). This file is automatically looped by the simulator. Default is elevmove.wav. Leave the filename field blank for no sound. The first command specifies both up and down sounds, while the others are for either upwards movement or downwards movement.
Example: MotorRunSound = run.wav

9. MotorStopSound, MotorUpStopSound, MotorDownStopSound - the sound file to play when the elevator motor slows down and stops (sets both directions). Default is elevstop.wav. Leave the filename field blank for no sound. The first command specifies both up and down sounds, while the others are for either upwards movement or downwards movement.
Example: MotorStopSound = stop.wav

10. MotorIdleSound - the sound file to play when the elevator motor is idling. There is no default yet. Leave the filename field blank for no sound.
Example: MotorIdleSound = idle.wav

11. FloorSkipText - sets the text that will be shown in the floor indicator when passing non-serviced floors. The texture for this must be loaded for it to show (and will start with the related indicator's texture prefix) - of you set this to EX for example, and the indicator's texture prefix is "Button", the texture it'll load will be ButtonEX.jpg. Common values for this are EZ, X, and EX (which stand for Express Zone).
Example: FloorSkipText = EZ

12. RecallFloor - sets the floor the elevator will recall to during fire service phase 1 mode. Default is the lowest serviced floor.
Example: RecallFloor = 5

13. AlternateRecallFloor - sets the alternate floor the elevator will recall to during fire service phase 1 mode. Default is the highest serviced floor.
Example: AlternateRecallFloor = 6

14. ACP - enables ACP (Anti-Crime Protection) mode
Example: ACP = true

15. ACPFloor - sets the floor the elevator will stop at while in ACP mode. Default is the lowest serviced floor.
Example: ACPFloor = 5

16. MotorPosition - sets the position of the motor sound emitter; if this command is not specified, it'll be placed at the base (altitude + interfloor) of the highest floor in the corresponding shaft. The X and Z values are relative of the elevator center.
Syntax: MotorPosition = x, y, z
Example: MotorPosition = 0, 100, 0

17. QueueResets - set this to true if you want the elevator to reset the related queue (up or down) after it reaches the last valid entry. If the elevator is moving up for example with this setting on, and you press buttons for floors below you, the elevator will remove those entries after it reaches the highest selected floor. The elevator will only be available for hall calls in the active queue direction.
Example: QueueResets = true

18. LimitQueue - set this to true to only allow floor selections in the same direction as the active elevator queue direction to be placed. For example, if the elevator is moving up, and a button is pressed for a lower floor, this will prevent that from being queued. The elevator will only be available for hall calls in the active queue direction.
Example: LimitQueue = true

19. UpPeak - enables up peak mode for this elevator.
Example: UpPeak = true

20. DownPeak - enables down peak mode for this elevator.
Example: DownPeak = true

21. InspectionService - enables inspection service mode for this elevator.
Example: InspectionService = true

22. InspectionSpeed - speed multiplier for inspection service (if set to 0.6, would be 60% of elevator speed)
Syntax: InspectionSpeed = multiplier

23. Parking - enables automatic elevator parking. If this option is used, the elevator will automatically send itself to the specified parking floor after the number of seconds specified in delay.
Syntax: Parking = floor, delay

24. LevelingSpeed - elevator's leveling speed. Default is 0.2
Syntax: LevelingSpeed = speed

25. LevelingOffset - distance in feet from the destination floor that the elevator will switch into leveling mode. Default is 0.5
Syntax: LevelingOffset = distance

26. LevelingOpen - distance in feet from the destination floor that the elevator will open the doors. Default is 0.
Syntax: LevelingOpen = distance

27. NotifyEarly - changes behavior of arrival notifications (chime, lighting of directional indicator, and floor announcement sound). 0 is the default and notifies when the elevator stops on the floor. 1 notifies when the elevator starts the leveling process, and 2 notifies when the elevator starts decelerating. A value of 3 combines 0 and 2 so that the elevator notifies twice. A value of -1 turns off standard notifications.
Syntax: NotifyEarly = value

28. NotifyLate - if set to true, the elevator car performs an arrival notification (chime, lighting of directional indicator, and floor announcement sound) after the doors open. False is the default.
Syntax: NotifyEarly = value

29. DepartureDelay - sets the time in seconds that the elevator waits before proceeding to the next floor. Default is 0.
Syntax: DepartureDelay = 1

30. ArrivalDelay - sets the time in seconds that the elevator waits before opening the doors after arriving at a floor. The default is 0. Note that a value greater than 0 will switch off the LevelingOpen setting.
Syntax: ArrivalDelay = 0.5

31. FireService1 - sets the fire service phase 1 mode that the elevator will start with. Default is 0. Values are 0 for off, 1 for on, 2 for bypass.
Syntax: FireService1 = 2

32. AutoDoors - if this is set to true, the elevator doors will automatically open if instructed (for example, when arriving at a floor), and will refuse to open if between floors. Set to false for manual elevators. The default is true.
Example: AutoDoors = false

33. OpenOnStart - if this is set to true, the elevator doors will automatically open on startup. The default is false.
Example: OpenOnStart = false

34. Interlocks - if this is set to true, the elevator doors will remain locked while the elevator is moving, will refuse to open unless the elevator is within a landing zone, and the elevator will not move unless the doors are closed. The default is true.
Example: Interlocks = false

35. FloorHold - if this is set to true, the user must hold down the floor button in order to move to the desired floor. When the button is released, the elevator will immediately stop. This is used to mimic a modern manual elevator (platform lift). The default is false.
Example: FloorHold = true

36. MotorEmergencyStopSound - the sound file to play for the elevator motor when an emergency stop is initiated. Leave the filename field blank to use the normal motor stop sound, if specified. The default is emergstop.wav
Example: MotorEmergencyStopSound = emergstop.wav

37. EmergencyStopSpeed - the speed multiplier to use for an emergency stop. A value of 3, the default, would mean 3 times the normal deceleration rate.
Example: EmergencyStopSpeed = 2.5

38. ChimeOnArrival - if set to true, the elevator will always chime when arriving to a floor. If false (the default), the elevator will only chime when responding to a hall call.
Example: ChimeOnArrival = true

39. ReOpen - if this is set to true, if the elevator is idle, the doors will reopen if the same floor is selected. The default is true.
Example: ReOpen = false

40. HoistwayAccessHold - if this is set to true, the control switch in Hoistway Access mode needs to be held in the direction position, for the elevator to move. The default is true.
Example: HoistwayAccessHold = false

41. RunState - if this is set to false, the elevator starts in a stopped state. The default is true.
Example: RunState = false

42. RopePosition - sets the position of the rope connection with the elevator. All values are relative of the elevator center.
Syntax: RopePosition = x, y, z
Example: RopePosition = 0, 8, 0

43. RopeTexture - the texture to use for the elevator rope.
Example: RopeTexture = Rope

44. CounterweightStartSound - the sound file to play for the counterweight when starting movement.
Example: CounterweightStartSound = weight_start.wav

45. CounterweightMoveSound - the sound file to play for the counterweight during movement.
Example: CounterweightMoveSound = weight_move.wav

46. CounterweightStopSound - the sound file to play for the counterweight when stopping movement.
Example: CounterweightStopSound = weight_stop.wav

Commands:

1. CreateElevator - creates an elevator at the specified location
Syntax: CreateElevator relative, x, z, floor
Example: CreateElevator false, 0, 10, 0

Relative determines if the coordinates are relative to the shaft center, or if they're absolute, X and Z are the coordinates to place the center of the elevator at, and Floor is the floor to place the elevator on.

2. CreateCounterweight - creates an elevator counterweight at the specified location. This should normally be used at the end of the Elevator section, after all cars are created. This command not only creates the counterweight, but also creates the counterweight and elevator ropes. The rope texture is specified in the RopeTexture parameter.
Syntax: CreateCounterweight frame_texture, weight_texture, x, z, size_x, size_y, size_z, weight_voffset
Example: CreateCounterweight CounterweightFrame, Counterweight, 0, 3.5, 2, 6, 0.5, 0.5

X and Z are the coordinates to place the center of the counterweight at, relative of the elevator center, size_x, size_y, size_z are the size of the counterweight, and weight_voffset is the vertical offset the weight should be at.

3. AddRails - creates rails on all relevant floors of a shaft, for either an elevator or counterweight. X and Z are relative of the elevator center. Orientation is either false to create the rails along X, or true to create them along Z. Rail_distance is the distance between the rail and the center of the elevator, and rail_width is the size of the rail. This command must be specified after the MotorPosition parameter.
Syntax: AddRails main_texture, edge_texture, x, z, orientation, rail_distance, rail_width
Example: AddRails Rails, RailsEdge, 0, 3.5, false, 1 + 0.06, 0.1

7. The Car (Elevator) Section

In order to support multi-deck elevators, each elevator car can be defined separately. The Car section is a subsection of the Elevator section, and allows you to create additional cars for your elevator. These are also numbered, starting with 1.

To create additional cars, this section is normally placed right after the elevator's CreateElevator command.

The section headers and footers are similar to the ones in the Elevator section.
To specify a single car, you would type something like:
<Car 2>
and end it with:
<EndCar>

For a range of elevators, you would use something like:
<Cars 1 to 2>
and end with:
<EndCars>

When creating a new elevator car, the required values for each are the ServicedFloors parameter and the CreateCar command.

Variables:

%elevator% - number of the current elevator
%car% - number of the current car

Parameters:

1. Name - sets the name of the car
Example: Name = Lower Car

2. OpenSpeed - open/close speed of the elevator doors. This must be specified after the CreateCar command.
Syntax: OpenSpeed doornumber = value
Example: OpenSpeed 1 = 0.2

3. SlowSpeed - open/close speed multiplier of the elevator doors used for slow movement, usually nudge mode. The default is 0.5, which ends up being half of the door's speed value. This must be specified after the CreateCar command.
Syntax: SlowSpeed doornumber = value
Example: SlowSpeed 1 = 0.2

4. ManualSpeed - open/close speed multiplier of the elevator doors used for manual movement. The default is 0.2. This must be specified after the CreateCar command.
Syntax: ManualSpeed doornumber = value
Example: ManualSpeed 1 = 0.2

5. ServicedFloors - a comma-separated list of floors this elevator car services. Ranges can also be specified by putting a "-" between the numbers. Please note that each car must serve different floors.
Example: ServicedFloors = 0, 5, 6, 7-30, 31

6. DoorTimer - the length of time (in milliseconds) that the elevator doors should stay open before automatically closing. Specify 0 to disable. The default is 5000, or 5 seconds. This must be specified after the CreateCar command.
Syntax: DoorTimer doornumber = value
Example: DoorTimer 1 = 10000

7. QuickClose - the length of time (in milliseconds) that the elevator doors should stay open before automatically closing, in quick-close mode. Specify 0 to disable. The default is 3000, or 3 seconds. This must be specified after the CreateCar command.
Syntax: QuickClose doornumber = value
Example: QuickClose 1 = 10000

8. NudgeTimer - the length of time (in seconds) that the doors have to remain open before the elevator car activates nudge mode for the related door. Specify 0 to disable. The default is 30 seconds. This must be specified after the CreateCar command.
Syntax: NudgeTimer doornumber = value
Example: NudgeTimer 1 = 10

9. OpenSound - the sound file to play when the elevator doors open. Default is elevatoropen.wav. Leave the filename field blank for no sound. This must be specified after the CreateCar command.
Syntax: OpenSound doornumber = filename
Example: OpenSound 1 = open.wav

10. CloseSound - the sound file to play when the elevator doors close. Default is elevatorclose.wav. Leave the filename field blank for no sound. This must be specified after the CreateCar command.
Syntax: CloseSound doornumber = filename
Example: CloseSound 1 = close.wav

11. CarStartSound, CarUpStartSound, CarDownStartSound - the sound file to play when the elevator car starts moving/speeds up. Leave the filename field blank for no sound. By default no sound is played. The first command specifies both up and down sounds, while the others are for either upwards movement or downwards movement.
Example: CarStartSound = start.wav

12. CarMoveSound, CarUpMoveSound, CarDownMoveSound - the sound file to play while the elevator car is moving. This file is automatically looped by the simulator. By default no sound is played. Leave the filename field blank for no sound. The first command specifies both up and down sounds, while the others are for either upwards movement or downwards movement.
Example: CarMoveSound = move.wav

13. CarStopSound, CarUpStopSound, CarDownStopSound - the sound file to play when the elevator car slows down and stops. By default no sound is played. Leave the filename field blank for no sound. The first command specifies both up and down sounds, while the others are for either upwards movement or downwards movement.
Example: CarStopSound = stop.wav

14. CarIdleSound - the sound file to play when the elevator car is idle (generally the fan sound). Default is elevidle.wav. Leave the filename field blank for no sound.
Example: CarIdleSound = idle.wav

15. ChimeSound - the sound file to play when the elevator car arrives at a floor. Default is chime1.wav. This must be specified after the CreateCar command. This is used for both up and down chimes. Leave the filename field blank for no sound.
Syntax: ChimeSound doornumber = filename
Example: ChimeSound 1 = chime.wav

16. UpChimeSound - the sound file to play when the elevator car arrives at a floor and it's direction is up. Default is chime1-up.wav. Leave the filename field blank for no sound. This must be specified after the CreateCar command.
Syntax: UpChimeSound doornumber = filename
Example: UpChimeSound 1 = chime.wav

17. DownChimeSound - the sound file to play when the elevator car arrives at a floor and it's direction is down. Default is chime1-down.wav. Leave the filename field blank for no sound. This must be specified after the CreateCar command.
Syntax: DownChimeSound doornumber = filename
Example: DownChimeSound 1 = chime.wav

18. EarlyUpChimeSound - the sound file to play during an early arrival notification of the elevator and the direction is up.. Default is chime1-up.wav. Leave the filename field blank for no sound. This must be specified after the CreateCar command.
Syntax: EarlyUpChimeSound doornumber = filename
Example: EarlyUpChimeSound 1 = chime.wav

19. EarlyDownChimeSound - the sound file to play during an early arrival notification of the elevator, and the direction is up. Default is chime1-down.wav. Leave the filename field blank for no sound. This must be specified after the CreateCar command.
Syntax: EarlyDownChimeSound doornumber = filename
Example: EarlyDownChimeSound 1 = chime.wav

20. AlarmSound - the sound file to play when the elevator car's alarm button is pressed. Default is bell1.wav. Leave the filename field blank for no sound.
Example: AlarmSound = bell2.wav

21. AlarmSoundStop - the sound file to play when the elevator car's alarm button is released. Leave the filename field blank for no sound. Default is bell1-stop.wav.
Example: AlarmSoundStop = bell2-stop.wav

22. BeepSound - the sound file to play when the elevator car reaches a new floor. There is no default; if this is set, the beeps will be automatically enabled. If an asterisk (*) is specified, it is replaced with the current floor number.
Example: BeepSound = beep.wav

23. FloorSound - the sound file(s) to play when the elevator car arrives at a floor; normally this is used for files that speak the floor number. There is no default; if this is set, the sounds will be automatically enabled. If an asterisk (*) is specified, it is replaced with the current floor number.
Example: FloorSound = floor*.wav

24. UpMessage - the notification sound file(s) to play after the elevator car arrives at a floor and the doors open - this tells the passengers that the elevator is going up. There is no default; if this is set, the sound will be automatically enabled. If an asterisk (*) is specified, it is replaced with the current floor number.
Example: UpMessage = goingup.wav

25. DownMessage - the notification sound file(s) to play after the elevator car arrives at a floor and the doors open - this tells the passengers that the elevator is going down. There is no default; if this is set, the sound will be automatically enabled. If an asterisk (*) is specified, it is replaced with the current floor number.
Example: DownMessage = goingdown.wav

26. OpenMessage - the notification sound file(s) to play when the elevator doors begin opening - this tells the passengers that the doors are opening. There is no default; if this is set, the sound will be automatically enabled. If an asterisk (*) is specified, it is replaced with the current floor number.
Example: OpenMessage = doorsopening.wav

27. CloseMessage - the notification sound file(s) to play when the elevator doors begin closing - this tells the passengers that the doors are closing. There is no default; if this is set, the sound will be automatically enabled. If an asterisk (*) is specified, it is replaced with the current floor number.
Example: CloseMessage = doorsclosing.wav

28. Music - the sound file to play for the elevator car music - the sound is automatically looped. There is no default; if this is set, the sound will be automatically enabled.
Example: Music = musicfile.wav

27. NudgeSound - the sound file to play while in nudge mode. Default is buzz.wav. Leave the filename field blank for no sound. This must be specified after the CreateCar command.
Syntax: NudgeSound doornumber = filename
Example: NudgeSound 1 = buzz.wav

29. Doors - sets the number of doors the elevator car will have. The default is 1. Set to 0 in order to have a doorless elevator car.
Example: Doors = 2

30. MusicPosition - sets the position of the music sound emitter relative of the elevator car's position. If this command is not specified, it'll be placed in the center of the elevator car on the ceiling.
Syntax: MusicPosition = x, y, z
Example: MusicPosition = 0, 8, 0

31. MusicOn - Enables or disables music on start. Default is true.
Syntax: MusicOn = false

32. MusicOnMove - Determines if music should only be played while the elevator is moving or not. Default is false.
Syntax: MusicOnMove = true

33. DisplayFloors - sets the floors that will be displayed by the elevator car's indicators. This command uses the same syntax as the ServicedFloors command.
Syntax: DisplayFloors = 0, 9, 19, 29

34. AutoEnable - Determines if interior objects should automatically be enabled or disabled when the user enters/exits the elevator car (set to false for glass elevators).
Syntax: AutoEnable = false

35. DoorSensor - enable or disable the door sensor (electric eye), which is a trigger object placed in the elevator door area. Default is enabled for automatic doors. A second parameter specifies the sound file to play when switching between on and off - this is normally used for a relay switch sound effect. Only specify the first parameter for no sound. This must be specified after the CreateCar command.
Syntax: DoorSensor doornumber = enable[, filename]
Example: DoorSensor 1 = true, click.wav

To have the sensor play a continuous beep while it's on (obstructed), create a sound inside the elevator car with the AddSound command using the filename of the beep sound you want, and then create an action with the elevator car's "sensor" command name. So for elevator 1 car 1, you would create an action named "Elevator 1:Car 1:sensor", and the action would do a "playsound" command on the sound you created.

36. CarEmergencyStopSound - the sound file to play for the elevator car when an emergency stop is initiated. Leave the filename field blank to use the normal car stop sound, if specified. By default no sound is played.
Example: CarEmergencyStopSound = emergstop_car.wav

37. IndependentService - enables independent service mode for the elevator, and makes this car the active car for the mode.
Example: IndependentService = true

38. FireService2 - sets the fire service phase 2 mode that the elevator will start with, and makes this car the active car for the mode. Default is 0. Values are 0 for off, 1 for on, 2 for hold.
Syntax: FireService2 = 1

Commands:

1. CreateCar - creates an elevator car on the specified floor. This command is only used for creating additional cars, since the elevator's CreateElevator command creates Car 1 automatically. The Floor value must be greater than the previous car's floor.
Syntax: CreateCar floor
Example: CreateCar 1

2. AddFloor - adds a textured floor with the specified dimensions for the car
Syntax: AddFloor name, texturename, thickness, x1, z1, x2, z2, voffset1, voffset2, reverse_axis, texture_direction, tw, th
Example: AddFloor Floor1, Wood2, 0.5, -3.5, -3, 3.5, 3, 0, 0, false, false, 0, 0

3. AddWall - adds a textured wall for the car
Syntax: AddWall name, texturename, thickness, x1, z1, x2, z2, height1, height2, voffset1, voffset2, tw, th
Example: AddWall Wall1, Wood1, 0.5, -3.5, 3, 3.5, 3, 8, 8, 0, 0, 2, 2

The car's AddWall command is similar to the other AddWall commands.

4. AddDoors - creates elevator car doors
Syntax: AddDoors number, lefttexture, righttexture, thickness, CenterX, CenterZ, width, height, direction, tw, th

The AddDoors command creates working elevator car doors at the central location specified by CenterX and CenterZ, with width and height specifiying the width and height of each door, and Direction specifying the direction that the doors face (currently there are only 2: false if the doors are on the left or right sides, and true if the doors are on the front or back sides). Number specifies the number of the door to create (related to the Doors command) - if the car only has one door, or if the Doors command was not used, specify 1 here.

5. AddShaftDoors - creates elevator shaft doors
Syntax: AddShaftDoors number, lefttexture, righttexture, thickness, CenterX, CenterZ, voffset, tw, th

The AddShaftDoors command creates working elevator shaft doors at the central location specified by CenterX and CenterZ. Other parameters such as width, height, and direction are taken from the AddDoors command (so the regular elevator car doors need to be created first). The voffset parameter allows you to create shaft doors at a different vertical position than the base of the floor, and the elevator will automatically stop according to the shaft door's voffset for that floor. These doors should be moved slightly away from the car doors (to separate them both). Also, this command creates doors at all the floors specified in the ServicedFloors value, and cuts any shaft walls that are within the door area (and so this must be called after the shaft walls are created). Number specifies the number of the door to create (related to the Doors command) - if the elevator car only has one door, or if the Doors command was not used, specify 1 here.

6. CreatePanel - creates a button panel
Syntax: CreatePanel texturename, rows, columns, direction, CenterX, CenterZ, buttonwidth, buttonheight, spacingX, spacingY, voffset, tw, th
Example: CreatePanel Wall1, 5, 5, right, -3, -3, 0.15, 0.15, 0.3, 0.45, 4.5, 0, 0

The CreatePanel command creates a button panel at a position relative to the elevator car's center position (origin). Rows and Columns define the grid size of the panel. Direction is either "front", "back", "left" or "right", defining which direction the panel faces. SpacingX is the space (percent of a button's width) horizontally between each button, and spacingY is the space (percent of a button's height) vertically between each button. Not all positions need to be used; this is simply to provide a grid layout for the panel. This command also determines the width and height of the panel based on the spacing and button sizes. A simple formula for determining panel width or height is this - for width, it's (columns * buttonwidth) + (spacingX * (columns + 1)); for height, just swap columns with rows and spacingX with spacingY. If a texture is not specified, the back portion of the panel will not be shown.

7. AddButton - creates a standard button on the panel
Syntax: AddButton panel_number, sound, texture_unlit, texture_lit, row, column, floor/type, width, height[, hoffset, voffset]
Example 1: AddButton 1, switch.wav, Button5, ButtonLit5, 7, 3, 4, 1, 1
Example 2: AddButton 1, , Button5, ButtonLit5, 7, 3, 4, 1, 1, 0.1, -0.1

The AddButton command creates a button on the button panel created with CreatePanel. Panel_number specifies the number of the panel to add the button to. Row and Column specify the position on the grid where the button should be. Floor/Type specifies either the floor number that this button calls, or the action name such as "Open" (see the AddControl command for more info). Width and Height specify the width and height of the button, as a percentage of a single grid unit size (1 being 100%, 0.5 being 50%). If both values are 0, the default of 1 is used for both values. If only one of the values is 0, then the exact size other is used; for example, if width is 0 and height is 1 (or any other number), then the width will end up being the same size as the height. Hoffset and Voffset are optional parameters, and are used to position the button outside the normal grid, and are in grid units (buttonwidth and buttonheight parameters of the CreatePanel function). In the second example, the button is positioned 0.1 grid units to the right, and 0.1 grid units down. Notice that no sound is specified in the 2nd example - this means that a sound won't be played.

8. AddControl - advanced command for creating buttons, switches and knobs on the panel
Syntax: AddControl panel_number, sound, row, column, width, height, hoffset, voffset, selection_position, command_name(s), texture_name(s)
Example 1: AddControl 1, switch.wav, 7, 3, 1, 1, 0, 0, 1, open, ButtonOpen
Example 2: AddControl 1, switch.wav, 7, 3, 1, 1, 0, 0, 1, FanOff, FanOn, SwitchFanOff, SwitchFanOn
Example 3: AddControl 1, switch.wav, 7, 3, 1, 1, 0, 0, 1, Off, 4, Button5, ButtonLit5
Example 4: AddControl 1, switch.wav, 7, 3, 1, 1, 0, 0, 1, Fire2Off, Fire2On, Fire2Hold, FireKnob1, FireKnob2, FireKnob3

The AddControl command creates an advanced control on the specified button panel (created with CreatePanel). Most of the parameters are the same as the AddButton command, but the command_name(s) and texture_name(s) parameters allow you to specify a list of commands, and a list of textures to go along with those commands. A texture needs to be specified for every command; if you specify 3 commands and only 2 textures, you will get an error. The first example shows a door open button being created, with the command "open" and the texture "ButtonOpen". The 2nd example shows a fan switch being created, with the first command being "FanOff" with the "SwitchFanOff" texture being used for that, and "FanOn" for the second command with the "SwitchFanOn" texture being used for that. Example 3 shows a standard floor button being created (which is what the AddButton command does) and example 4 shows a fire service mode knob being created with 3 positions. Leave the sound field blank for no sound to be played. The selection_position parameter specifies the starting selection position, which is normally 1.

Available command names for elevators:

Off (no action)
[floor number] (specify only the floor number to send elevator to that floor)
Open [door] (open doors)
Close [door] (close doors)
OpenInt [door] (open interior/car doors)
CloseInt [door] (close interior/car doors)
OpenExt [door] (open exterior/shaft doors)
CloseExt [door] (close exterior/shaft doors)
OpenManual [door] (open doors manually)
CloseManual [door] (close doors manually)
OpenIntManual [door] (open interior/car doors manually)
CloseIntManual [door] (close interior/car doors manually)
OpenExtManual [door] (open exterior/shaft doors manually)
CloseExtManual [door] (close exterior/shaft doors manually)
StopDoors [door] (stop doors during manual movement)
Cancel (call cancel)
Run (put elevator in run state)
Stop (put elevator in stop state)
EStop (emergency stop)
Alarm (alarm trigger)
Fire1Off (fire service phase 1 off for all elevators in same bank, which means all served by first call button on recall floor)
Fire1On (fire service phase 1 on for all elevators in same bank)
Fire1Bypass (fire service phase 1 bypass for all elevators in same bank)
Fire2Off (fire service phase 2 off)
Fire2On (fire service phase 2 on)
Fire2Hold (fire service phase 2 hold)
UpPeakOn (enable up peak)
UpPeakOff (disable up peak)
DownPeakOn (enable down peak)
DownPeakOff (disable down peak)
PeakOff (disable both peak modes)
IndOn (enable independent service mode)
IndOff (disable independent service)
InsOn (enable inspection service mode)
InsOff (disable inspection service)
AcpOn (enable ACP mode)
AcpOff (disable ACP mode)
FanOn (enable fan/idle sound)
FanOff (disable fan/idle sound)
Hold [door] (hold door and disable door sensor temporarily)
MusicOn (enable music sound)
MusicOff (disable music sound)
UpOn (inspection mode or manual elevator up on)
UpOff (inspection mode or manual elevator up off)
DownOn (inspection mode or manual elevator down on)
DownOff (inspection mode or manual elevator down off)
GoOn (inspection mode go on)
GoOff (inspection mode go off)
Return (return to nearest serviced floor after stop)
Up (move up for manual elevator, for a button held by mouse button)
Down (move down for manual elevator, for a button held by mouse button)
InterlocksOn (enable interlocks)
InterlocksOff (disable interlocks)
Sensor [door] (open and hold doors without disabling sensor, used by door sensor)
Reset [door] (reset door timer and turn on door sensor, which turns off hold)
SensorOn [door] (enable door sensor)
SensorOff [door] (disable door sensor)
SensorReset [door] (same as Reset but doesn't touch sensor setting)

Some commands in the above list have an optional Door parameter. For example, Open 2 will open door 2, while Open or Open 0 will open all doors.

When this command is used, actions are created using the specified commands. The resulting names of the actions are the elevator name, followed by a colon, then the Car name followed by another colon, and then the command name, in order to be unique to each elevator and car. So the "Open" command for Elevator 1 Car 1 is created as an action named "Elevator 1:Car 1:open", and you can specify more actions with that name to run multiple actions when the elevator car opens it's doors.

9. AddFloorIndicator - creates a floor indicator
Syntax: AddFloorIndicator texture_prefix, blank_texture, direction, CenterX, CenterZ, width, height, voffset

The AddFloorIndicator command creates a floor indicator at the position (relative to the elevator car) specified by CenterX and CenterZ. Direction is the direction the indicator faces, and can be either "left", "right", "front" or "back". This command can be given multiple times to create multiple indicators. Texture_prefix is the base name of the texture to load when displaying a floor ID; for example if the elevator car is on floor 3, and you specify a prefix of "Button", it'll load the "Button3" texture. Blank_texture specifies a texture to be used when the indicator is blank.

10. AddDirectionalIndicator - creates an internal directional indicator/lantern
Syntax: AddDirectionalIndicator ActiveDirection, Single, Vertical, BackTexture, UpTexture, UpTextureLit, DownTexture, DownTextureLit, CenterX, CenterZ, voffset, direction, BackWidth, BackHeight, ShowBack, tw, th
Example: AddDirectionalIndicator false, false, true, Metal, UpLight, UpLightOn, DownLight, DownLightOn, -3, -4.162, 6, front, 0.5, 1, true, 0, 0

This command will create a directional indicator inside the elevator car, and the positioning is relative of the elevator car's center.