Difference between revisions of "TrainCarts/Commands"
m (→Reroute) |
Bergerkiller (talk | contribs) |
||
(12 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
− | [[TrainCarts|« Go back]] | + | <languages/> |
+ | <translate> | ||
+ | <!--T:1--> | ||
+ | [[Special:MyLanguage/TrainCarts|« Go back]] | ||
− | == Introduction == | + | == Introduction == <!--T:2--> |
+ | <!--T:3--> | ||
Commands are used to control trains or single carts through chat commands. They can also be used to perform routine tasks, such as removing all trains from a world. | Commands are used to control trains or single carts through chat commands. They can also be used to perform routine tasks, such as removing all trains from a world. | ||
− | == Syntax | + | === Syntax basics === <!--T:4--> |
− | To perform a command, either use '''/train ''' or '''/cart '''. When using the train version, you want to operate on the entire train or perform a global train command. When using the cart version, you want to operate on a single cart | + | <!--T:5--> |
+ | To perform a command, either use '''/train ''' or '''/cart '''. When using the train version, you want to operate on the entire train or perform a global train command. When using the cart version, you want to operate on a single cart. | ||
− | == | + | === Selecting === <!--T:43--> |
+ | Commands that target a specific train (''/train'') or cart (''/cart'') require the player to select the train or cart first. This can be done by: | ||
+ | * Entering the cart | ||
+ | * Sneaking and damaging the cart, so it doesn't break (creative) | ||
+ | * Spawning a new train with the [[Special:MyLanguage/TrainCarts/Train Spawn Chest|train spawn chest]] | ||
+ | * Looking at the cart, and running command <code>/train edit</code> | ||
+ | * Listing trains with <code>/train list</code> and clicking on a train name, or specifying the name of the train in the <code>/train edit [name]</code> command | ||
+ | === Targeting Flags === <!--T:42--> | ||
+ | Instead of first selecting a cart to modify, you can use any of the following flags to target trains directly. These also work in Command Blocks. | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! style="width: 15%" | Flag | ||
+ | ! style="width: 25%" | Example | ||
+ | ! Description | ||
+ | |- | ||
+ | | --train <name> | ||
+ | | /train maxspeed 0.0 --train train12<br>/train maxspeed --train @train[name=intercity*] | ||
+ | | Selects a train by name. Supports the [[Special:MyLanguage/TrainCarts/Commands/Selectors|''@train'' selector]] in place of the name, with which you can target more than one train at a time. | ||
+ | |- | ||
+ | | --nearest | ||
+ | | /train maxspeed 0.0 --nearest | ||
+ | | Selects the nearest train to the sender. At most 128 blocks away. | ||
+ | |- | ||
+ | | --near <x> <y> <z> <distance> | ||
+ | | /train maxspeed 0.0 --near ~ ~ ~ 5 | ||
+ | | Selects the nearest train near to the coordinates specified, at most distance away | ||
+ | |- | ||
+ | | --cart <index or entity_uuid> | ||
+ | | /cart destroy --nearest --cart 0 | ||
+ | | Selects a single cart from the front. Index 0 is the front, 1 second from front, etc. The words 'head' and 'tail' can also be used to select the first or last cart. The train of which to select the carts can be selected with the other flags, otherwise the train the player is currently editing is used. | ||
+ | |- | ||
+ | | --world <worldname> | ||
+ | | /train destroy --world world_nether --near 2 66 -134 1.5 | ||
+ | | By default flags only target the world the sender is on. With this, a different world can be specified. Is required when running commands from the server terminal. | ||
+ | |} | ||
+ | |||
+ | == Global commands == <!--T:6--> | ||
+ | |||
+ | <!--T:7--> | ||
The below commands only work on ''/train'' and don't require a selection to function. | The below commands only work on ''/train'' and don't require a selection to function. | ||
− | === List === | + | |
+ | === List === <!--T:8--> | ||
+ | |||
+ | <!--T:9--> | ||
<pre>/train list | <pre>/train list | ||
/cart list</pre> | /cart list</pre> | ||
Lists the number of stationary and moving trains in the world. It also lists the total number of cart entities (as part of those trains) and lists the trains that belong to you. | Lists the number of stationary and moving trains in the world. It also lists the total number of cart entities (as part of those trains) and lists the trains that belong to you. | ||
− | |||
+ | === Reroute === <!--T:10--> | ||
+ | |||
+ | <!--T:11--> | ||
<pre>/train reroute [--lazy]</pre> | <pre>/train reroute [--lazy]</pre> | ||
If the path finding system is failing because the track got changed, you can use this command to force the plugin to re-calculate all destination paths. | If the path finding system is failing because the track got changed, you can use this command to force the plugin to re-calculate all destination paths. | ||
+ | <!--T:12--> | ||
<strong>The '--lazy' -Parameter:</strong><br> | <strong>The '--lazy' -Parameter:</strong><br> | ||
<p>Normally the command takes all previous nodes which known existed and schedules them for routing.<br> | <p>Normally the command takes all previous nodes which known existed and schedules them for routing.<br> | ||
With the '--lazy' parameter, this happens once a cart goes towards a switcher sign, and <u>only</u> from that node. | With the '--lazy' parameter, this happens once a cart goes towards a switcher sign, and <u>only</u> from that node. | ||
− | |||
+ | === Destroy all === <!--T:13--> | ||
+ | |||
+ | <!--T:14--> | ||
<pre>/train destroyall | <pre>/train destroyall | ||
/train removeall</pre> | /train removeall</pre> | ||
Destroys all minecarts and trains on the server. Can be useful to re-set the plugin. | Destroys all minecarts and trains on the server. Can be useful to re-set the plugin. | ||
− | |||
+ | === Fix bugged === <!--T:15--> | ||
+ | |||
+ | <!--T:16--> | ||
<pre>/train fixbugged</pre> | <pre>/train fixbugged</pre> | ||
Destroys all minecarts that are not managed by the plugin. Useful for is the server was shut down unexpectedly, leaving orphaned trains on the track. | Destroys all minecarts that are not managed by the plugin. Useful for is the server was shut down unexpectedly, leaving orphaned trains on the track. | ||
− | |||
+ | == Train - only commands == <!--T:17--> | ||
+ | |||
+ | <!--T:18--> | ||
The below commands work only for ''/train''. | The below commands work only for ''/train''. | ||
− | |||
+ | === Rename === <!--T:19--> | ||
+ | |||
+ | <!--T:20--> | ||
<pre>/train setname [name] | <pre>/train setname [name] | ||
/train name [name] | /train name [name] | ||
Line 49: | Line 106: | ||
Sets the name of the train, the name may not be assigned to another train already | Sets the name of the train, the name may not be assigned to another train already | ||
− | |||
+ | === Set display name === <!--T:21--> | ||
+ | |||
+ | <!--T:22--> | ||
<pre>/train setdname [name] | <pre>/train setdname [name] | ||
/train displayname [name] | /train displayname [name] | ||
Line 56: | Line 115: | ||
Sets the display name of the train, may be double-assigned. This name is displayed on SignLink-variable signs when using trigger signs. | Sets the display name of the train, may be double-assigned. This name is displayed on SignLink-variable signs when using trigger signs. | ||
− | |||
+ | == Train and Cart commands == <!--T:23--> | ||
+ | |||
+ | <!--T:24--> | ||
The below commands work for both ''/train'' and ''/cart''. | The below commands work for both ''/train'' and ''/cart''. | ||
− | |||
+ | === Information === <!--T:25--> | ||
+ | |||
+ | <!--T:26--> | ||
<pre>/train info | <pre>/train info | ||
/train i</pre> | /train i</pre> | ||
Shows train or cart related information, such as the name and set properties. | Shows train or cart related information, such as the name and set properties. | ||
− | |||
+ | ==== Ownership ==== <!--T:27--> | ||
+ | |||
+ | <!--T:28--> | ||
<pre>/train claim</pre> | <pre>/train claim</pre> | ||
Sets you as the only owner of this train. | Sets you as the only owner of this train. | ||
Line 78: | Line 143: | ||
Adds the owner names to this train. | Adds the owner names to this train. | ||
+ | <!--T:29--> | ||
To change ownership of a single minecart, use the '/cart' command instead of '/train'. When setting train owners, you set owners on all minecarts simultaneously. If no owners are set for a minecart, it can be freely edited and destroyed by everyone else. | To change ownership of a single minecart, use the '/cart' command instead of '/train'. When setting train owners, you set owners on all minecarts simultaneously. If no owners are set for a minecart, it can be freely edited and destroyed by everyone else. | ||
− | |||
+ | ==== Tags ==== <!--T:30--> | ||
+ | |||
+ | <!--T:31--> | ||
<pre>/train settags [tags...] | <pre>/train settags [tags...] | ||
/train settag [tags...] | /train settag [tags...] | ||
Line 92: | Line 160: | ||
Add tags to this train. | Add tags to this train. | ||
+ | <!--T:32--> | ||
Tags can be used in combination with switcher or detector signs. For example, you can set a tag to order a train to be destroyed. Every minecart has a separate set of tags, setting tags on a train sets it for all minecarts simultaneously. | Tags can be used in combination with switcher or detector signs. For example, you can set a tag to order a train to be destroyed. Every minecart has a separate set of tags, setting tags on a train sets it for all minecarts simultaneously. | ||
− | |||
+ | ==== Destination ==== <!--T:33--> | ||
+ | |||
+ | <!--T:34--> | ||
<pre>/train destination [destination] | <pre>/train destination [destination] | ||
/train dest [destination]</pre> | /train dest [destination]</pre> | ||
Sets the destination for this train. | Sets the destination for this train. | ||
+ | <!--T:35--> | ||
You can also set a destination on a single minecart in the train, this way letting switcher signs split trains up in multiple carriages. | You can also set a destination on a single minecart in the train, this way letting switcher signs split trains up in multiple carriages. | ||
− | |||
+ | ==== Player enter ==== <!--T:36--> | ||
+ | |||
+ | <!--T:37--> | ||
<pre>/train playerenter [bool]</pre> | <pre>/train playerenter [bool]</pre> | ||
Sets if players can enter the train or minecart. | Sets if players can enter the train or minecart. | ||
− | |||
+ | ==== Player exit ==== <!--T:38--> | ||
+ | |||
+ | <!--T:39--> | ||
<pre>/train playerexit [bool] | <pre>/train playerexit [bool] | ||
/train playerleave [bool]</pre> | /train playerleave [bool]</pre> | ||
Sets if players can exit the train or minecart. | Sets if players can exit the train or minecart. | ||
− | |||
+ | ==== Pick up ==== <!--T:40--> | ||
+ | |||
+ | <!--T:41--> | ||
<pre>/train pickup [bool]</pre> | <pre>/train pickup [bool]</pre> | ||
Sets if the storage minecart(s) (in the train) pick up nearby items from the ground. | Sets if the storage minecart(s) (in the train) pick up nearby items from the ground. | ||
+ | |||
+ | ==== Collision ==== <!--T:44--> | ||
+ | |||
+ | <!--T:45--> | ||
+ | <pre>/train collision mobs enter | ||
+ | /train collision player push | ||
+ | /train collision train cancel | ||
+ | /train collision block cancel</pre> | ||
+ | Set collision rules. This can be used to allow mobs to enter the train when they collide with it, disable trains linking or push players aside when they are in the way. Setting collision with blocks to cancel will make the train no longer check for collisions with blocks, which can help with performance. | ||
+ | |||
+ | </translate> |
Latest revision as of 15:20, 23 September 2024
Introduction
Commands are used to control trains or single carts through chat commands. They can also be used to perform routine tasks, such as removing all trains from a world.
Syntax basics
To perform a command, either use /train or /cart . When using the train version, you want to operate on the entire train or perform a global train command. When using the cart version, you want to operate on a single cart.
Selecting
Commands that target a specific train (/train) or cart (/cart) require the player to select the train or cart first. This can be done by:
- Entering the cart
- Sneaking and damaging the cart, so it doesn't break (creative)
- Spawning a new train with the train spawn chest
- Looking at the cart, and running command
/train edit
- Listing trains with
/train list
and clicking on a train name, or specifying the name of the train in the/train edit [name]
command
Targeting Flags
Instead of first selecting a cart to modify, you can use any of the following flags to target trains directly. These also work in Command Blocks.
Flag | Example | Description |
---|---|---|
--train <name> | /train maxspeed 0.0 --train train12 /train maxspeed --train @train[name=intercity*] |
Selects a train by name. Supports the @train selector in place of the name, with which you can target more than one train at a time. |
--nearest | /train maxspeed 0.0 --nearest | Selects the nearest train to the sender. At most 128 blocks away. |
--near <x> <y> <z> <distance> | /train maxspeed 0.0 --near ~ ~ ~ 5 | Selects the nearest train near to the coordinates specified, at most distance away |
--cart <index or entity_uuid> | /cart destroy --nearest --cart 0 | Selects a single cart from the front. Index 0 is the front, 1 second from front, etc. The words 'head' and 'tail' can also be used to select the first or last cart. The train of which to select the carts can be selected with the other flags, otherwise the train the player is currently editing is used. |
--world <worldname> | /train destroy --world world_nether --near 2 66 -134 1.5 | By default flags only target the world the sender is on. With this, a different world can be specified. Is required when running commands from the server terminal. |
Global commands
The below commands only work on /train and don't require a selection to function.
List
/train list /cart list
Lists the number of stationary and moving trains in the world. It also lists the total number of cart entities (as part of those trains) and lists the trains that belong to you.
Reroute
/train reroute [--lazy]
If the path finding system is failing because the track got changed, you can use this command to force the plugin to re-calculate all destination paths.
The '--lazy' -Parameter:
Normally the command takes all previous nodes which known existed and schedules them for routing.
With the '--lazy' parameter, this happens once a cart goes towards a switcher sign, and only from that node.
Destroy all
/train destroyall /train removeall
Destroys all minecarts and trains on the server. Can be useful to re-set the plugin.
Fix bugged
/train fixbugged
Destroys all minecarts that are not managed by the plugin. Useful for is the server was shut down unexpectedly, leaving orphaned trains on the track.
Train - only commands
The below commands work only for /train.
Rename
/train setname [name] /train name [name] /train rename [name]
Sets the name of the train, the name may not be assigned to another train already
Set display name
/train setdname [name] /train displayname [name] /train setdisplayname [name]
Sets the display name of the train, may be double-assigned. This name is displayed on SignLink-variable signs when using trigger signs.
Train and Cart commands
The below commands work for both /train and /cart.
Information
/train info /train i
Shows train or cart related information, such as the name and set properties.
Ownership
/train claim
Sets you as the only owner of this train.
/train setowner [names...] /train setowners [names...] /train setowners
Sets the owner names of this train. Use no names to clear the owners.
/train addowner [names...] /train addowners [names...]
Adds the owner names to this train.
To change ownership of a single minecart, use the '/cart' command instead of '/train'. When setting train owners, you set owners on all minecarts simultaneously. If no owners are set for a minecart, it can be freely edited and destroyed by everyone else.
Tags
/train settags [tags...] /train settag [tags...] /train tags [tags...] /train tag [tags...] /train settags
Sets the tags of this train. Use no tags to clear the tags.
/train addtags [tags...] /train addtag [tags...]
Add tags to this train.
Tags can be used in combination with switcher or detector signs. For example, you can set a tag to order a train to be destroyed. Every minecart has a separate set of tags, setting tags on a train sets it for all minecarts simultaneously.
Destination
/train destination [destination] /train dest [destination]
Sets the destination for this train.
You can also set a destination on a single minecart in the train, this way letting switcher signs split trains up in multiple carriages.
Player enter
/train playerenter [bool]
Sets if players can enter the train or minecart.
Player exit
/train playerexit [bool] /train playerleave [bool]
Sets if players can exit the train or minecart.
Pick up
/train pickup [bool]
Sets if the storage minecart(s) (in the train) pick up nearby items from the ground.
Collision
/train collision mobs enter /train collision player push /train collision train cancel /train collision block cancel
Set collision rules. This can be used to allow mobs to enter the train when they collide with it, disable trains linking or push players aside when they are in the way. Setting collision with blocks to cancel will make the train no longer check for collisions with blocks, which can help with performance.