Help:Design Guide - Revision history

MelvinMan10: /* The Buildings Section */

2026-09-27T13:27:47Z

The Buildings Section

← Older revision		Revision as of 08:27, 27 September 2026
Line 697:		Line 697:

	== The Buildings Section ==		== The Buildings Section ==
			The ''Buildings'' section allows you to load additional [[buildings]], into separate simulation engines, and have them all be visible and usable in the same scene. This section is small, and mainly exists to provide clarity in scripts. Additional buildings also have their own script interpreters, so their scripts (and things such as includes) are completely isolated from each other. Note that this section is skipped when reloading the building (Ctrl-R). This section should be placed at the beginning of the script file, so that the progress bar during load can be accurate. When the script is finished loading, the primary building (the one included in the main script) will be automatically cut for each child building (using the section's Cut parameters), making it easy to integrate new buildings into existing spaces with large landscapes, or even [[City Demo\|city]] [[City Simulation\|blocks]]. Nesting of this section is also supported, so that if a child building also has a buildings section, it'll process it, and the parent building will be cut for each child building.
	The ''Buildings'' section allows you to load additional buildings, into separate simulation engines, and have them all be visible and usable in the same scene. This section is small, and mainly exists to provide clarity in scripts. Additional buildings also have their own script interpreters, so their scripts (and things such as includes) are completely isolated from each other. Note that this section is skipped when reloading the building (Ctrl-R). This section should be placed at the beginning of the script file, so that the progress bar during load can be accurate. When the script is finished loading, the primary building (the one included in the main script) will be automatically cut for each child building (using the section's Cut parameters), making it easy to integrate new buildings into existing spaces with large landscapes, or even city blocks. Nesting of this section is also supported, so that if a child building also has a buildings section, it'll process it, and the parent building will be cut for each child building.

	The section starts with this header:<br>		The section starts with this header:<br>
Line 715:		Line 714:
	#CutFloors - if this is set to true, cut the Floors meshes of buildings, discarding the area outside of the building's set boundaries. Default is false, since this may have an unnecessary performance impact<br><code>CutFloors = true</code>		#CutFloors - if this is set to true, cut the Floors meshes of buildings, discarding the area outside of the building's set boundaries. Default is false, since this may have an unnecessary performance impact<br><code>CutFloors = true</code>
	=== Commands ===		=== Commands ===
	*Load - load a building, creating a new Engine Context (script interpreter and sim engine pair) for it. This command requires a building filename to be specified, and optionally allows the position to be set (which overrides the Position value in that building's Globals section), the rotation (Y axis, which is left/right) in degrees to be set, and the bounds values to be set (which also overrides the building's Bounds value). For the rotation value, if "90" is specified, the building is rotated so that it faces the right. If the value is "270" or "-90", the building faces the left. The Bounds values are used to determine the position limits of what are considered that building, where if a building has a position X value of 200, and the MinX is -100 and MaxX is 100, the global positions of 100X to 300X are "inside" that building's space (200 - 100, and 200 + 100). Subfolders are supported, so a filename of "myfolder/mybuilding.bld" will load the building file at "buildings/myfolder/mybuilding.bld".<br>Syntax: <code>Load filename['', X, Y, Z, Rotation'']['', MinX, MinY, MinZ, MaxX, MaxY, MaxZ'']</code>		*Load - load a building, creating a new Engine Context (script interpreter and sim engine pair) for it. This command requires a building filename to be specified, and optionally allows the position to be set (which overrides the Position value in that building's Globals section), the rotation (Y axis, which is left/right) in degrees to be set, and the bounds values to be set (which also overrides the building's Bounds value). For the rotation value, if "90" is specified, the building is rotated so that it faces the right. If the value is "270" or "-90", the building faces the left. The Bounds values are used to determine the position limits of what are considered that building, where if a building has a position X value of 200, and the MinX is -100 and MaxX is 100, the global positions of 100X to 300X are "inside" that building's space (200 - 100, and 200 + 100). Subfolders are supported, so a filename of "myfolder/mybuilding.bld" will load the building file at "[[buildings]]/myfolder/mybuilding.bld".<br>Syntax: <code>Load filename['', X, Y, Z, Rotation'']['', MinX, MinY, MinZ, MaxX, MaxY, MaxZ'']</code>
	**Example 1: <code>Load Simple.bld</code>		**Example 1: <code>Load Simple.bld</code>
	**Example 2: <code>Load Simple.bld, 200, 0, 200, 0</code>		**Example 2: <code>Load Simple.bld, 200, 0, 200, 0</code>

MelvinMan10: /* Parameters */

2026-09-27T13:20:05Z

Parameters

← Older revision		Revision as of 08:20, 27 September 2026
Line 433:		Line 433:
	#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.<br>Syntax: <code>QuickClose ''doornumber = value''</code><br>Example: <code>QuickClose 1 = 10000</code>		#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.<br>Syntax: <code>QuickClose ''doornumber = value''</code><br>Example: <code>QuickClose 1 = 10000</code>
	#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.<br>Syntax: <code>NudgeTimer ''doornumber = value''</code><br>Example: <code>NudgeTimer 1 = 10</code>		#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.<br>Syntax: <code>NudgeTimer ''doornumber = value''</code><br>Example: <code>NudgeTimer 1 = 10</code>
	#OpenSound - the [{Data#Sounds\|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.<br>Syntax: <code>OpenSound ''doornumber = filename''</code><br>Example: <code>OpenSound 1 = open.wav</code>		#OpenSound - the [[Data#Sounds\|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.<br>Syntax: <code>OpenSound ''doornumber = filename''</code><br>Example: <code>OpenSound 1 = open.wav</code>
	#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.<br>Syntax: <code>CloseSound doornumber = filename</code><br>Example: <code>CloseSound 1 = close.wav</code>		#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.<br>Syntax: <code>CloseSound doornumber = filename</code><br>Example: <code>CloseSound 1 = close.wav</code>
	#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.<br>Example: <code>CarStartSound = start.wav</code>		#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.<br>Example: <code>CarStartSound = start.wav</code>

MelvinMan10: /* Parameters */

2026-09-27T13:19:29Z

Parameters

← Older revision		Revision as of 08:19, 27 September 2026
Line 433:		Line 433:
	#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.<br>Syntax: <code>QuickClose ''doornumber = value''</code><br>Example: <code>QuickClose 1 = 10000</code>		#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.<br>Syntax: <code>QuickClose ''doornumber = value''</code><br>Example: <code>QuickClose 1 = 10000</code>
	#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.<br>Syntax: <code>NudgeTimer ''doornumber = value''</code><br>Example: <code>NudgeTimer 1 = 10</code>		#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.<br>Syntax: <code>NudgeTimer ''doornumber = value''</code><br>Example: <code>NudgeTimer 1 = 10</code>
	#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.<br>Syntax: <code>OpenSound ''doornumber = filename''</code><br>Example: <code>OpenSound 1 = open.wav</code>		#OpenSound - the [{Data#Sounds\|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.<br>Syntax: <code>OpenSound ''doornumber = filename''</code><br>Example: <code>OpenSound 1 = open.wav</code>
	#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.<br>Syntax: <code>CloseSound doornumber = filename</code><br>Example: <code>CloseSound 1 = close.wav</code>		#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.<br>Syntax: <code>CloseSound doornumber = filename</code><br>Example: <code>CloseSound 1 = close.wav</code>
	#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.<br>Example: <code>CarStartSound = start.wav</code>		#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.<br>Example: <code>CarStartSound = start.wav</code>

MelvinMan10: /* The Elevator Section */

2026-09-27T13:18:26Z

The Elevator Section

← Older revision		Revision as of 08:18, 27 September 2026
Line 324:		Line 324:

	== The Elevator Section ==		== The Elevator Section ==
			The ''Elevator'' section allows you to create elevators for your [[building]]. Elevators are numbered, starting with 1.
	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.		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.
Line 355:		Line 354:
	#DecelJerk - deceleration jerk rate of the elevator (rate of change of deceleration)<br>Example: <code>DecelJerk = 1.0</code>		#DecelJerk - deceleration jerk rate of the elevator (rate of change of deceleration)<br>Example: <code>DecelJerk = 1.0</code>
	#AssignedShaft - the shaft number this elevator is in<br>Example: <code>AssignedShaft = 1</code>		#AssignedShaft - the shaft number this elevator is in<br>Example: <code>AssignedShaft = 1</code>
	#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.<br>Example: <code>MotorStartSound = start.wav</code>		#MotorStartSound, MotorUpStartSound, MotorDownStartSound - the [[Data#Sounds\|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.<br>Example: <code>MotorStartSound = start.wav</code>
	#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.<br>Example: <code>MotorRunSound = run.wav</code>		#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.<br>Example: <code>MotorRunSound = run.wav</code>
	#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.<br>Example: <code>MotorStopSound = stop.wav</code>		#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.<br>Example: <code>MotorStopSound = stop.wav</code>

MelvinMan10: /* Parameters */

2026-09-27T13:17:19Z

Parameters

← Older revision		Revision as of 08:17, 27 September 2026
Line 276:		Line 276:
	#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".<br><code>ID = %floor%</code>		#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".<br><code>ID = %floor%</code>
	#NumberID - the numeric ID for the current floor, used mainly for Destination Dispatch keypads. This is preferred instead of the floor number, because floor numbers start at 0, and are used as a floor array instead of the actual floor numbers that you would prefer. If your building has a floor 0, you would set NumberID to 1 for that floor. Floor 13 for example can be skipped by setting NumberID to 14.<br><code>NumberID = 14</code>		#NumberID - the numeric ID for the current floor, used mainly for Destination Dispatch keypads. This is preferred instead of the floor number, because floor numbers start at 0, and are used as a floor array instead of the actual floor numbers that you would prefer. If your building has a floor 0, you would set NumberID to 1 for that floor. Floor 13 for example can be skipped by setting NumberID to 14.<br><code>NumberID = 14</code>
	#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, [[:Category:Hotels\|Hotel]], Apartment, Condominium, Restaurant, Observatory, Recreation, Ballroom, Communications, and Roof. (Required)<br><code>Type = Office</code>		#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, [[:Category:Office buildings\|Office]], Service, Skylobby, [[:Category:Hotels\|Hotel]], [[:Category:Residential buildings\|Apartment]], Condominium, Restaurant, Observatory, [[:Category:Malls\|Recreation]], Ballroom, Communications, and Roof. (Required)<br><code>Type = Office</code>
	#Description - description of the current floor, optional<br><code>Description = Offices</code>		#Description - description of the current floor, optional<br><code>Description = Offices</code>
	#Height - the floor-to-ceiling height of the current floor, required<br><code>Height = 9.5</code>		#Height - the floor-to-ceiling height of the current floor, required<br><code>Height = 9.5</code>

MelvinMan10 at 13:15, 27 September 2026

2026-09-27T13:15:19Z

← Older revision		Revision as of 08:15, 27 September 2026
Line 2:		Line 2:
	''All of the text below was created by eventhorizon.''		''All of the text below was created by eventhorizon.''

	This document describes how to create your own [[buildings]] for the Skyscraper ~~simulator~~, and also describes all of the available commands. Please note that the commands and syntax will change frequently during the simulator's development, and formatting will be cleaned up to make the code more readable. A graphical building designer is planned, which will generate these script files based on simplified CAD-like floorplan layouts, and will also allow the user to view the building in 3D as it's being created.		This document describes how to create your own [[buildings]] for the [[Skyscraper Wiki:About\|Skyscraper Simulator]], and also describes all of the available commands. Please note that the commands and syntax will change frequently during the simulator's development, and formatting will be cleaned up to make the code more readable. A graphical building designer is planned, which will generate these script files based on simplified CAD-like floorplan layouts, and will also allow the user to view the building in 3D as it's being created.

	== Starting a new building ==		== Starting a new building ==
Line 15:		Line 15:
	To add a comment to your file, simply put the # symbol right before your comment. For example:<br><code><nowiki># This is a comment</nowiki></code>		To add a comment to your file, simply put the # symbol right before your comment. For example:<br><code><nowiki># This is a comment</nowiki></code>

	It's a good idea to use comment markers to add a title header at the top of your building file. The Triton Center file has this header:<br>		It's a good idea to use comment markers to add a title header at the top of your [[building]] file. The [[Triton Center]] file has this header:<br>
	<code><nowiki>#The Triton Center</nowiki></code><br>		<code><nowiki>#The Triton Center</nowiki></code><br>
	<code><nowiki>#Copyright ©2002-2013 Ryan Thoryk</nowiki></code>		<code><nowiki>#Copyright ©2002-2013 Ryan Thoryk</nowiki></code>
Line 41:		Line 41:

	=== Inline calculations ===		=== Inline calculations ===

	Values can be calculated inline by using the following math operators:		Values can be calculated inline by using the following math operators:
	<code>+</code> (plus), <code>-</code> (minus), <code>/</code> (divide), <code><nowiki>*</nowiki></code> (multiply), and <code>^</code> (power of)		<code>+</code> (plus), <code>-</code> (minus), <code>/</code> (divide), <code><nowiki>*</nowiki></code> (multiply), and <code>^</code> (power of)
Line 52:		Line 51:

	=== Object parameters from outside floor sections ===		=== Object parameters from outside floor sections ===

	Information about a certain floor can be obtained elsewhere in the script, by referencing the floor in this manner:		Information about a certain floor can be obtained elsewhere in the script, by referencing the floor in this manner:
	*<code>Floor(number).parameter</code>		*<code>Floor(number).parameter</code>
Line 63:		Line 61:

	=== Includes ===		=== Includes ===

	Other script files can be included (inserted) anywhere in the current script by using the <code><Include></code> command. Scripts can be included multiple times, and included scripts can include other scripts.		Other script files can be included (inserted) anywhere in the current script by using the <code><Include></code> command. Scripts can be included multiple times, and included scripts can include other scripts.

Line 74:		Line 71:

	=== Functions ===		=== Functions ===

	Functions can be created to share code between sections of scripts, and also between entire scripts when used in conjunction with includes. An unlimited number of parameters can be specified for each function. If a function is specified with the same name as a previously defined function, the function will be skipped and a warning will be printed. This can only be used outside of any section, such as <code><Floor></code>.		Functions can be created to share code between sections of scripts, and also between entire scripts when used in conjunction with includes. An unlimited number of parameters can be specified for each function. If a function is specified with the same name as a previously defined function, the function will be skipped and a warning will be printed. This can only be used outside of any section, such as <code><Floor></code>.

Line 118:		Line 114:

	=== Advanced Math Functions ===		=== Advanced Math Functions ===

	Several built-in advanced math functions are provided, mostly for trigonometric calculations.		Several built-in advanced math functions are provided, mostly for trigonometric calculations.

Line 185:		Line 180:

	== The Globals Section ==		== 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:<br>
	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:<br>
	<code><Globals></code>		<code><Globals></code>

Line 246:		Line 240:

	== The Floor Sections ==		== 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.		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:<br>		For a single floor, the section would start with this:<br>
Line 268:		Line 261:

	=== Variables ===		=== Variables ===

	* %floor% - contains the current floor number		* %floor% - contains the current floor number
	* %height% - contains the current floor's ceiling height		* %height% - contains the current floor's ceiling height
Line 281:		Line 273:

	=== Parameters ===		=== Parameters ===

	#Name - the name of the current floor, required<br>Example: <code>Name = Floor %floor%</code>		#Name - the name of the current floor, required<br>Example: <code>Name = Floor %floor%</code>
	#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".<br><code>ID = %floor%</code>		#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".<br><code>ID = %floor%</code>
	#NumberID - the numeric ID for the current floor, used mainly for Destination Dispatch keypads. This is preferred instead of the floor number, because floor numbers start at 0, and are used as a floor array instead of the actual floor numbers that you would prefer. If your building has a floor 0, you would set NumberID to 1 for that floor. Floor 13 for example can be skipped by setting NumberID to 14.<br><code>NumberID = 14</code>		#NumberID - the numeric ID for the current floor, used mainly for Destination Dispatch keypads. This is preferred instead of the floor number, because floor numbers start at 0, and are used as a floor array instead of the actual floor numbers that you would prefer. If your building has a floor 0, you would set NumberID to 1 for that floor. Floor 13 for example can be skipped by setting NumberID to 14.<br><code>NumberID = 14</code>
	#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)<br><code>Type = Office</code>		#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, [[:Category:Hotels\|Hotel]], Apartment, Condominium, Restaurant, Observatory, Recreation, Ballroom, Communications, and Roof. (Required)<br><code>Type = Office</code>
	#Description - description of the current floor, optional<br><code>Description = Offices</code>		#Description - description of the current floor, optional<br><code>Description = Offices</code>
	#Height - the floor-to-ceiling height of the current floor, required<br><code>Height = 9.5</code>		#Height - the floor-to-ceiling height of the current floor, required<br><code>Height = 9.5</code>

MelvinMan10: /* The Textures Section */

2026-09-27T13:13:04Z

The Textures Section

← Older revision		Revision as of 08:13, 27 September 2026
Line 223:		Line 223:

	== The Textures Section ==		== The Textures Section ==
			The '''Textures''' section loads [[Data#Textures\|textures]] into the simulation and assigns names to them, for use in the rest of the sections. The section starts with this header:<br><code><Textures></code>
	The '''Textures''' section loads textures into the simulation and assigns names to them, for use in the rest of the sections. The section starts with this header:<br><code><Textures></code>

	and ends with this footer:		and ends with this footer:

Lighthouse Friesland: /* Global Commands/Functions */

2026-05-24T17:28:06Z

Global Commands/Functions

← Older revision		Revision as of 12:28, 24 May 2026
Line 607:		Line 607:
	#ShowFullStairs - determines if an entire stairwell should be shown. If set to "true" or "inside", the full stairwell is shown only when the user is inside the stairwell. If set to "always", the full stairwell is always shown. Setting this to true is useful for stairwells that have a gap in the center between the actual stairs.<br>Syntax: <code>ShowFullStairs ''StairwellNumber = value''</code><br>Example: <code>ShowFullStairs 1 = inside</code>		#ShowFullStairs - determines if an entire stairwell should be shown. If set to "true" or "inside", the full stairwell is shown only when the user is inside the stairwell. If set to "always", the full stairwell is always shown. Setting this to true is useful for stairwells that have a gap in the center between the actual stairs.<br>Syntax: <code>ShowFullStairs ''StairwellNumber = value''</code><br>Example: <code>ShowFullStairs 1 = inside</code>
	#TextureFlip - flips specified textures for the next command.. Currently only works with the different AddWall, AddFloor and AddInterFloor commands. The values available are 0 for no flipping, 1 for horizontal flip, 2 for vertical flip, and 3 for both horizontal and vertical.<br>Syntax: <code>TextureFlip ''MainNegative, MainPositive, SideNegative, SidePositive, Top, Bottom''</code><br>Example: <code>TextureFlip 1, 1, 0, 0, 0, 0</code><br>This command will allow you to flip textures on specific parts of a wall or floor created with a command such as AddWall. It will only work on the command immediately after this one. In the above example, the Main Positive and Main Negative sides of the object will have their textures flipped horizontally.		#TextureFlip - flips specified textures for the next command.. Currently only works with the different AddWall, AddFloor and AddInterFloor commands. The values available are 0 for no flipping, 1 for horizontal flip, 2 for vertical flip, and 3 for both horizontal and vertical.<br>Syntax: <code>TextureFlip ''MainNegative, MainPositive, SideNegative, SidePositive, Top, Bottom''</code><br>Example: <code>TextureFlip 1, 1, 0, 0, 0, 0</code><br>This command will allow you to flip textures on specific parts of a wall or floor created with a command such as AddWall. It will only work on the command immediately after this one. In the above example, the Main Positive and Main Negative sides of the object will have their textures flipped horizontally.
	#Cut - performs a manual box cut on an object<br>Syntax: <code>Cut destobject, ''x1, y1, z1, x2, y2, z2, cutwalls, cutfloors''</code><br>Example: <code>Cut external, -5, -5, -5, 5, 5, 5, false, true</code><br>The ''x, y'' and ''z'' values specify the start and end coordinates of the box cut. If ''cutwalls'' is true, the function will cut walls; if ''cutfloors'' is true, it'll cut floors.		#Cut - performs a 2d manual box cut on an object<br>Syntax: <code>Cut destobject, ''x1, y1, z1, x2, y2, z2, cutwalls, cutfloors''</code><br>Example: <code>Cut external, -5, -5, -5, 5, 5, 5, false, true</code><br>The ''x, y'' and ''z'' values specify the start and end coordinates of the box cut. If ''cutwalls'' is true, the function will cut walls; if ''cutfloors'' is true, it'll cut floors.
			#Cut3d - performs a 3d manual box cut on an object<br>Syntax: <code>Cut3d destobject, ''x1, y1, z1, x2, y2, z2, cutwalls, cutfloors''</code><br>Example: <code>Cut3d external, -5, -5, -5, 5, 5, 5, false, true</code><br>The ''x, y'' and ''z'' values specify the start and end coordinates of the box cut. If ''cutwalls'' is true, the function will cut walls; if ''cutfloors'' is true, it'll cut floors.<br>The regular Cut command cuts most objects fine, but the 3D cut is capable of cutting 3d objects such as spheres.
	#Mount - mounts a zip file in the data directory into a virtual path.<br>Syntax: <code>Mount ''filename, path''</code><br>Example: <code>Mount myfile.zip, mydirectory</code><br>In this example, the file myfile.zip located in Skyscraper's data directory will be mounted as "mydirectory", and so a file such as test.jpg inside that zip file will appear as "mydirectory/test.jpg".		#Mount - mounts a zip file in the data directory into a virtual path.<br>Syntax: <code>Mount ''filename, path''</code><br>Example: <code>Mount myfile.zip, mydirectory</code><br>In this example, the file myfile.zip located in Skyscraper's data directory will be mounted as "mydirectory", and so a file such as test.jpg inside that zip file will appear as "mydirectory/test.jpg".
	#AddFloorAutoArea - defines an area that will automatically enable and disable floors when the user moves within it, similar to a stairwell<br>Syntax: <code>AddFloorAutoArea ''x1, y1, z1, x2, y2, z2''</code><br>Example: <code>AddFloorAutoArea -100, 0, -100, 100, 100, 100</code>		#AddFloorAutoArea - defines an area that will automatically enable and disable floors when the user moves within it, similar to a stairwell<br>Syntax: <code>AddFloorAutoArea ''x1, y1, z1, x2, y2, z2''</code><br>Example: <code>AddFloorAutoArea -100, 0, -100, 100, 100, 100</code>

Lighthouse Friesland at 14:13, 14 August 2025

2025-08-14T14:13:10Z

← Older revision		Revision as of 09:13, 14 August 2025
Line 631:		Line 631:
	#AddPrism - this command creates a prism in a given wall object. If created in a Floor section, the Y values will be relative to that floor's base.<br>Syntax: <code>AddPrism destobject, wallname, texturename, x, y, z, width, depth, height, tw, th, inside</code><br>Example: <code>AddPrism landscape, mywall, Brick, 0, 0, 0, 5, 5, 5, 1, 1, false</code>		#AddPrism - this command creates a prism in a given wall object. If created in a Floor section, the Y values will be relative to that floor's base.<br>Syntax: <code>AddPrism destobject, wallname, texturename, x, y, z, width, depth, height, tw, th, inside</code><br>Example: <code>AddPrism landscape, mywall, Brick, 0, 0, 0, 5, 5, 5, 1, 1, false</code>
	#AddTetrahedron - this command creates a tetrahedron in a given wall object. If created in a Floor section, the Y values will be relative to that floor's base.<br>Syntax: <code>AddTetrahedron destobject, wallname, texturename, x, y, z, size, tw, th, inside</code><br>Example: <code>AddTetrahedron landscape, mywall, Brick, 0, 0, 0, 5, 1, 1, false</code>		#AddTetrahedron - this command creates a tetrahedron in a given wall object. If created in a Floor section, the Y values will be relative to that floor's base.<br>Syntax: <code>AddTetrahedron destobject, wallname, texturename, x, y, z, size, tw, th, inside</code><br>Example: <code>AddTetrahedron landscape, mywall, Brick, 0, 0, 0, 5, 1, 1, false</code>
	#AddOctahedron - this command creates a octahedron in a given wall object. If created in a Floor section, the Y values will be relative to that floor's base.		#AddOctahedron - this command creates a octahedron in a given wall object. If created in a Floor section, the Y values will be relative to that floor's base.<br>Syntax: <code>AddOctahedron destobject, wallname, texturename, x, y, z, size, tw, th, inside</code><br>Example: <code>AddOctahedron landscape, mywall, Brick, 0, 0, 0, 5, 1, 1, false</code>
	Syntax: AddOctahedron destobject, wallname, texturename, x, y, z, size, tw, th, inside
	Example: AddOctahedron landscape, mywall, Brick, 0, 0, 0, 5, 1, 1, false
	#AddIcosahedron - this command creates an icosahedron in a given wall object. If created in a Floor section, the Y values will be relative to that floor's base.<br>Syntax: <code>AddIcosahedron destobject, wallname, texturename, x, y, z, radius, tw, th, inside</code><br>Example:<code>AddIcosahedron landscape, mywall, Brick, 0, 0, 0, 5, 1, 1, false</code>		#AddIcosahedron - this command creates an icosahedron in a given wall object. If created in a Floor section, the Y values will be relative to that floor's base.<br>Syntax: <code>AddIcosahedron destobject, wallname, texturename, x, y, z, radius, tw, th, inside</code><br>Example:<code>AddIcosahedron landscape, mywall, Brick, 0, 0, 0, 5, 1, 1, false</code>
	#AddGeosphere - this command creates a geosphere in a given wall object. If created in a Floor section, the Y values will be relative to that floor's base.<br>Syntax: <code>AddGeosphere destobject, wallname, texturename, x, y, z, radius, subdivisions, tw, th, inside</code><br>Example: <code>AddGeosphere landscape, mywall, Brick, 0, 0, 0, 5, 5, 1, 1, false</code>		#AddGeosphere - this command creates a geosphere in a given wall object. If created in a Floor section, the Y values will be relative to that floor's base.<br>Syntax: <code>AddGeosphere destobject, wallname, texturename, x, y, z, radius, subdivisions, tw, th, inside</code><br>Example: <code>AddGeosphere landscape, mywall, Brick, 0, 0, 0, 5, 5, 1, 1, false</code>

Lighthouse Friesland: Completed adding new features

2025-08-14T14:09:14Z

Completed adding new features

@@ Line 619: / Line 619: @@
 #AddPolygon - this is the same as the AddCustomWall command, but adds the custom polygon to an existing (usually custom) wall object, instead of creating a new one. The example below adds the polygon to the Landscape mesh object, to the custom-created "mywall" Wall Object, which was created with the CreateWallObject command. The polygon will be two-sided if the DrawWalls command's MainNegative and MainPositive parameters are true. If created in a Floor section, the Y values will be relative to that floor's base.<br>Syntax: <code>AddPolygon ''destobject, wallname, texturename, x1, y1, z1, x2, y2, z2, x3, y3, z3, ..., tw, th''</code><br>Example: <code>AddPolygon landscape, mywall, Brick, 0, 0, 0, 0, 10, 0, 10, 10, 0, 10, 0, 10, 0, 0</code>
 #ExtrudePoly - extrude the following polygon(s).  This command sets the thickness of the polygons following the command, and the side texture to use. The EndExtrude command resets the values to default. It works with the AddPolygon, AddCustomWall, and AddCustomFloor commands. In the example, the polygon created with the AddCustomWall command is thickened by 5 feet, with Brick being used as the side/filler texture. Tw and th are the tiling parameters for the sides.<br>Syntax: <code>ExtrudePoly side_texture, thickness, tw, th</code><br>Example:<br><code>DrawWalls = true, true, true, true, true, true</code><br><code>ExtrudePoly Brick, 5, 1, 1</code><br><code>AddCustomWall...</code><br><code>EndExtrude</code>
 #AddGeosphere - this command creates a geosphere in a given wall object. If created in a Floor section, the Y values will be relative to that floor's base.<br>Syntax: <code>AddGeosphere destobject, wallname, texturename, x, y, z, radius, subdivisions, tw, th, inside</code><br>Example: <code>AddGeosphere landscape, mywall, Brick, 0, 0, 0, 5, 5, 1, 1, false</code>
 #SetKey - specifies that the next created model will be a key. The model will be tagged with a specific key ID number, and when clicked, the key ID will be added to the user's keyring and the model will be deleted. The value must be greater than 0.<br>Syntax: <code>SetKey ''keyid''</code><br>Example: <code>SetKey 1</code>