Editing Escalator2011

{{legit}}
'''Escalator2011''' is a script that allows users to add realistic looking escalators more easily. It was made by escalatorgeek881 as part of the [[EG881 Integration Project]]. The description below was made by EG881 with details on how Escalator2011 works.
== How to Use ==
Escalator2011 was created to allow users to add escalators into their buildings by following a few basic and easy steps instead of spending hours trying to manually create them. Escalator2011 hopes to completely redefine the concept of building coding in Skyscraper, as it allows a new feature to be added into buildings. It now has all of the escalator code inside special functions, which are created in special script files. This feature allows you to add a bank of escalators on a single floor or among a range of floors with only one line of code, instead of inserting several lines of code that into your building code. Each release of Escalator2011 will have its own script file, which will allow backwards comparability when Escalator2011 is updated. Adding escalators is simpler than ever before, you no longer have to open up special text files and insert the code from those files into your building code.<br>
To add an escalator, follow these basic steps...<br>
# Before adding your escalators, place in this code (Function Activation Code). This will basically insert the functionscript into your building file, allowing you to place in the scripting code which actually creates the escalators.<br> <code> <Include Escalator2011/Scripts/r5_escalator_script.txt> </code>
# Now it is time to place in the function: <code>AddEscalators2</code>.<br>Here is the syntax (it is long, it is placed on several lines)...<br>
<code>AddEscalators2(number, numberofescalators, direction, startfloor, endfloor, steptexture, stepsidetexture, landingtexture, balustradetexture, walltexture, handrailtexture,<br>x, z, width, height, steps, lengthbetweenescalators, balustradewidth, useautomaticcutting, useautomaticrailings, extracutting, railingthickness, railingheight, railingtexture)</code><br>
Note that you can also place in AddAutoEscalators2 (syntax is the same), which will cause escalator units on particular floors to render and not render as you travel up/down the escalator bank.
== Examples ==
''Note: This is just a guideline on how parts of Escalator2011 work, meant to make it easier to code in escalators. If this section needs removing please let me know either [[Special:NewSection/Talk:Escalator2011|in the talk page]] or on [[Special:NewSection/User talk:Elevator1512|my user talk page]].''

<code>#Escalators<br>
<Include Escalator2011/Scripts/r5_escalator_script.txt>

AddEscalators2(1, 2, left, -1, 6, Escalator3X_Unmarked, Escalator3X_Unmarked, EscalatorLandingX, Balustrade1, Wall2, Handrail1, 20, 40, 3.5, 12, 18, 2, 0.5, true, true, 2, 0.5, 4, Wall2)<br>
AddAutoEscalators2(2, 2, left, -1, 6, Escalator3X_Unmarked, Escalator3X_Unmarked, EscalatorLandingX, Balustrade1, Wall2, Handrail1, 20, 40, 3.5, 12, 18, 2, 0.5, true, true, 2, 0.5, 4, Wall2)<br>
AddEscalators2(3, 2, left, -1, 6, Escalator3X_Unmarked, Escalator3X_Unmarked, EscalatorLandingX, Balustrade1, Wall2, Handrail1, 20, 40, 3.5, 12, 18, 2, 0.5, false, false)</code>
== Syntax Description ==
'''General'''
#number: each line of escalator code counts as one stairwell, so number as if each escalator is a stairwell
#numberofescalators: Specifies the number of escalators the unit(s) will have (currently only 1 and 2)
#direction: specifies direction in which the escalator faces (side where lower landing is), can be back, front, left, or right
#startfloor: specifies the lowest floor served
#endfloor: specifies the highest floor served, if you want to add an escalator spans multiple floors, place in the lowest floor + 1<br>'''Textures'''
#steptexture: this is the texture used on the escalator steps
#stepsidetexture: in most directions (except on left) this does nothing, but otherwise specifies the upright face of the steps
#landingtexture: this is the texture of the landings, which is the metal covering over the mechanical parts on the top and bottom of the escalator
#balustradetexture: this is the texture of the balustrades, should be a metal texture
#walltexture: this is the texture of the outer walls (external side of outer balustrades and underside)
#handrailtexture: this is the texture of the handrails<br>''' Position '''
#x: this is the central x (left-right) coordinate for the escalator bank
#z: this is the central z (front-back) coordinate for the escalator bank<br>'''Size'''
#width: this is the width of the escalators, default is 3.5
#height: this is the vertical height of the escalators
#steps: this is the number of steps the the escalators have, this is also the length of the escalators, this should be the height multiplied by 1.5 rounded to nearest whole number
#lengthbetweenescalators: in a double escalator setup, this is the width of the central balustrade, or the divider of the two escalators, the default is 2, the minimum is 1
#balustradewidth: this is the width of the outer balustrades (not the divider in AddDoubleEscalator), the default and minimum is 0.5<br>'''Cutting and Railings'''
#useautomaticcutting: Specifies whether to use automatic cutting (true) or not to use it (false).
#useautomaticrailings: Specifies whether to add automatic railings (true) or not to add them (false).
#extracutting: This determines the length of any desired extra cutting around the lateral sides of the escalators.
#railingthickness: Specifies the thickness of the railings.
#railingheight: Specifies the height of the railings (does not include interfloor height).
#railingtexture: Specifies the texture of the railings.
== Default Textures ==
Escalator2011 contains a small set of default escalator textures, which are bundled with Escalator2011 and do not have to be placed in the [[data]] folder.<br>

'''Tan-Colored Steps with Yellow Line'''

<code>EscalatorX: horizontal grooves, line on left<br>
EscalatorXB: horizontal grooves, line on right><br>
EscalatorX_Unmarked: horizontal grooves, no line</code>

<code>EscalatorZ: vertical grooves, line on bottom<br>
EscalatorZB: vertical grooves, line on top<br>
EscalatorZ_Unmarked: vertical grooves, no line</code>

'''Gray Steps with No Line'''

<code>Escalator2X: horizontal grooves, no line<br>
Escalator2XB: horizontal grooves, no line</code>

<code>Escalator2Z: vertical grooves, no line<br>
Escalator2ZB: vertical grooves, no line</code>

'''Black Steps with Yellow Line'''

<code>Escalator3X: horizontal grooves, line on left<br>
Escalator3XB: horizontal grooves, line on right<br>
Escalator3X_Unmarked: horizontal grooves, no line</code>

<code>Escalator3Z: vertical grooves, line on bottom<br>
Escalator3ZB: vertical grooves, line on top<br>
Escalator3Z_Unmarked: vertical grooves, no line</code>

'''Landings'''

<code>EscalatorLandingX: tancolored<br>
EscalatorLandingZ: tan-colored</code>

'''Accessories'''

<code>Balustrade1: dark stainless steel<br>
Handrail1: solid black</code>

== Releases ==
=== Release 1 (4/4/11) ===
#Code for creating a two-escalator bank facing back
#Basic information and instructions added
=== Release 2 (4/24/11) ===
#Code for creating a two-escalator bank facing front
#Instructions revised
#New configuration for number of steps, which is also the length of the escalator(s)
#Center Z changed to Upper Landing Z Coordinate, which is the endpoint in which is upper landing is located
#Diagrams added
#Slight changes to defaults
#Code for creating a two-escalator bank facing left
#Added multifloor code
#Code for creating a two-escalator bank facing right (single floor and multifloor)
#Small code revisions
=== Release 3 (5/15/11) ===
#Condensed and simplified code.
#Code has been migrated to functions.
#Code for creating single escalators.
=== Release 4 (6/5/11) ===
==== R3 Script (AddEscalator and AddDoubleEscalator) ====
#Created special code for automatic cutting and railings (R3 Script).
#Added new default textures (R3 Script)
#Default textures are now loaded automatically from a special folder (R3 Script)
==== R4 Script (AddEscalators) ====
#Single and double escalator code integrated into one function: AddEscalators (R4 Script)
#Automatic cuts and railings, which can be switched on and off (R4 Script)
#Added new default textures (R4 Script)
#Default textures are now loaded automatically from a special folder (R4 Script)
=== Release 5 (6/5/11) ===
==== R5 Script (AddEscalators2) ====
#New parameter for escalator landing texture
#Rearranged syntax.
== See also ==
* [[In-Code Basic Stairwell Creator]]
* [[Skyscraper Random Object Creator]]
[[Category:Scripts]]