Components/Main plugin
Depends on / uses
This is the core of Elevators. It is needed for any extension to work.
Features
- Creating, removing and modifying elevators and platforms
- Moving elevators / platforms by using commands
- Rails specify the movement directions for your personal platform / elevator
- Scalable: Developers can easily build new features with a modular extension system.
Guides
Commands: /elev|elevator|elevators
create [normal|flat|full] [<elevator name>]
| purpose | creates an elevator at your current location. |
|---|---|
| parameters | [normal|flat|full]: Describes which blocks will be used to form the elevator. Normal will use all blocks of the same type above which is air. Flat will ignore whether there is air above the blocks or not, the elevator may become much larger, be careful! Full will do the same as flat, but additionaly add all blocks above the platform as well, it's pretty much a combination of create and update. [<elevator name>]: give the new elevator a name. The elevator won't have any name if you leave it blank. |
| examples | /elev create /elev create MyElevator /elev create "cargo elevator" /elev create flat /elev create "personal elevator" |
delete|remove [<elevator name>]
| purpose | deletes the elevator at your current location or the one with the specified name. |
|---|---|
| parameters | [<elevator name>]: if specified, the elevator with this name will be deleted. Otherwise the elevator you are currently standing on will be deleted. |
| examples | /elev delete /elev remove /elev delete MyElevator /elev delete "cargo elevator" |
move [up|down|north|east|south|west|forward] [<distance>] [<elevator name>]
| purpose | moves the elevator the given distance to a specific direction. Without parameters, the elevator moves along any path it can find. |
|---|---|
| parameters | [up|down|north|east|south|west|forward]: The direction the elevator should move towards. If you use forward, the direction you are currently looking at will be used (doesn't work if you are looking up or down). When left out, the elevator will move somewhere... [<distance>]: The distance in blocks the elevator should move. If left out, the elevator will move the maximum distance possible. [<elevator name>]: If specified, the elevator with this name will move. Otherwise the elevator you are currently standing on will move. |
| examples | /elev move /elev move forward /elev move north 20 /elev move down 10 "cargo elevator" /elev move "personal elevator" /elev move up "MyElevator" |
name|rename [<new name>] [<old name>]
| purpose | displays the current name of the elevator you are standing on or changes an elevator's name |
|---|---|
| parameters | [<new name>]: The elevator will be renamed to this new name. If left out (no parameters passed), the current name will be displayed and the elevator won't be renamed. [<old name>]: If specified, the elevator with this old name will be renamed. Otherwise, the elevator you are currently standing on will be renamed. |
| examples | /elev name - Displays the name of the elevator you are standing on. /elev rename "official elevator" - The elevator you are standing on will be renamed to "official elevator". /elev rename "official elevator" "personal elevator" - Renames "personal elevator" to "official elevator" |
rail|rails [<rail id>] [<connector id>] [<elevator name>]
| purpose | displays or changes the material of rails and rail connector blocks for a specific elevator. |
|---|---|
| parameters | [<rail id>]: The block type of the rails this elevator will be using to move. If omitted or set to 0, the default rail type, as specified in the config, will be used. [<connector id>]: The block type of the connector block which is built into the elevator. If omitted or set to 0, the default connector type, as specified in the config, will be used. [<elevator name>]: If specified, the elevator with this name will be changed, otherwise the one you are currently standing on. |
| examples | /elev rails /elev rails "cargo elevator" - displays the current rail types of "cargo elevator". /elev rails 16 - sets the rail type to coal ore /elev rails 0 5:3 - sets the rail type back to default and the connector type to jungle wood planks /elev rails 16 5:3 "cargo elevator" - sets the rail type to coal ore and the connector type to jungle wood planks for "cargo elevator" |
stop [<elevator name>]
| purpose | immediately stops an elevator that is moving. |
|---|---|
| paramters | [<elevator name>]: If specified, the elevator with the given name is stopped, otherwise the one you are currently standing on. |
| examples | /elev stop /elev stop "cargo elevator" |
update [<elevator name>]
| purpose | updates the blocks you have placed on an elevator. This will look for new blocks built on top of the elevator, or blocks that have changed in the platform. You have to call this command to be able to move the elevator, after you have changed some blocks of it. |
|---|---|
| paramters | [<elevator name>]: If specified, the elevator with the given name is updated, otherwise the one you are currently standing on. |
| examples | /elev update /elev update "cargo elevator" |
Configuration: mainplugin
autosave -> enable
| purpose | enables / disables autosaving of elevators |
|---|---|
| possible values | true, false |
| default value | true |
autosave -> interval-in-seconds
| purpose | sets the time after which autosaving will be triggered (if enabled) |
|---|---|
| possible values | any integer greater than 0 |
| default value | 30 |
colors
| purpose | sets color for any messages sent to players |
|---|---|
| possible values for message types | aqua, black, blue, dark_aqua, dark_blue, dark_gray, dark_green, dark_purple, dark_red, gold, gray, green, light_purple, red, white, yellow |
| error default | red |
| command default | blue |
| info default | green |
| success default | dark_green |
movement -> delay-ticks
| purpose | delay in server-ticks (20 ticks are 1 second), which elevators will wait at each halt |
|---|---|
| possible values | integer 0 or greater |
| default value | 40 |
platform-size-limit
| purpose | limits the maximum size (in blocks) of any elevator platform. No larger elevators may be created. |
|---|---|
| possible values | any integer size in blocks |
| default value | 100 |
rails -> rail-type
| purpose | sets the type of elevator rails, used globally |
|---|---|
| possible values | a block type of the following syntax: '<type ID>:<data value>'. examples: '152' , '5:3' |
| default value | '152' |
rails -> rail-connector-type
| purpose | sets the type of elevator rail connectors, used globally |
|---|---|
| possible values | a block type of the following syntax: '<type ID>:<data value>' or '0' to use the same as in rails -> rail-type specified. examples: '152' , '5:3' |
| default value | '0' |
debugging -> enable
| purpose | enable / disable debugging console output. only for testing purposes. |
|---|---|
| possible values | true or false |
| default value | false |
debugging -> enable-timings
| purpose | enable / disable performance monitoring console output. only for testing purposes. |
|---|---|
| possible values | true or false |
| default value | false |
Comments