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:

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

1b. ID - sets the ID of the elevator, used for Destination Dispatch. The default is the number of the elevator.
Example: ID = A

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. RopeOffset - the vertical offset of the elevator rope, used to specify the height above the floor base that it extends, to connect to the motor mesh. The default is 0 (where the rope stops at the floor's base).
Example: RopeOffset = 5

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

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

47. 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