TrainCarts

https://wiki.traincarts.net/
Admin
TrainCarts is a Bukkit and Spigot Minecraft plugin that links minecarts into controllable trains...
Tokens:243,680
Snippets:2,458
Trust Score:5.3
Update:6 days ago
Show doc for...
Tokens:
Raw
### World Creation Examples

Source: https://wiki.traincarts.net/p/MyWorlds/Commands

Examples of creating worlds with different environments, seeds, and generators.

```text
/world create world1:BananaSpace:12,grass,wood,dirt -1856378464
```

```text
/world create world2 -527332672
```

```text
/world create world2_nether
```

```text
/world create mynether/nether
```

```text
/world create itssobig/largebiomes
```

```text
/world create world3_skylands
```

```text
/world create skylandsworld
```

--------------------------------

### Create and start a Task with a delay

Source: https://wiki.traincarts.net/p/BKCommonLib/Task

Shows how to create a Task subclass and start it with a 10-tick delay. The run() method broadcasts a message after the delay. The start() method returns the Task instance for chaining.

```java
Task myTask = new Task(MyPlugin.plugin) {
    @Override
    public void run() {
        Bukkit.broadcastMessage("Test after 10 ticks!");
    }
}.start(10);
```

--------------------------------

### World creation command examples

Source: https://wiki.traincarts.net/p/MyWorlds/ManagingWorlds/zh-cn

Examples of /world create commands with their results, including overworld, nether, flat, and generator plugin worlds.

```command
/world create world1
```

```command
/world create world1_nether
```

```command
/world create mynether/nether
```

```command
/world create HippoCraft/flat 251
```

```command
/world create waterworld/flat::2;7,5x1,5x3,5x12,90x9;1;biome_1,village
```

```command
/world create Space:bSpace:awesome
```

--------------------------------

### Run Paper server (java -jar)

Source: https://wiki.traincarts.net/p/Light-Cleaner

Starts the Paper server for the first time. It will fail and ask you to agree to the EULA; after editing eula.txt to set eula=true, run the same command again to start the server for real.

```bash
java -jar paper-1.12.2-1620.jar
```

--------------------------------

### Example existing collision configuration

Source: https://wiki.traincarts.net/p/Special%3AMyLanguage/TrainCarts/MobEntering

An example of a collision configuration that already has some options set, showing the format used in DefaultTrainProperties.yml.

```yaml
  collision:
    players: DEFAULT
    misc: PUSH
    train: LINK
    block: DEFAULT
```

--------------------------------

### /map give [player] command example

Source: https://wiki.traincarts.net/p/Maplands/Commands

Example of the give subcommand to give the map to another player. Requires the maplands.command.give permission. If no player is provided, the map is given to the executor.

```text
/map give Bergerkiller
```

--------------------------------

### values.yml configuration example

Source: https://wiki.traincarts.net/p/SignLink/en

Example configuration for values.yml. It sets default values for the plugin, including ticker direction and interval, and the value to display. Comments explain the properties.

```yaml
# In here you can set default values for this plugin.
# The ticker property can be LEFT, RIGHT or NONE and sets the direction message is 'ticked'.
# tickerInterval sets the amount of ticks (1/20 of a second) are between the ticker update.
# The value is the thing to display or tick.
# To use colors in your text, use the § sign followed up by a value from 0 - F.
# Example: §cRed to display a red colored 'Red' message.
# You can find all color codes on the internet (they may use & there, ignore that!)
sign:
    ticker: NONE
    value: This is a regular message you can set and is updated only once.
test:
    tickerInterval: 3
    ticker: LEFT
    value: 'This is a test message being ticked from right to left.'
```

--------------------------------

### MyWorlds world enter localization example

Source: https://wiki.traincarts.net/p/MyWorlds/Localization

Example from MyWorlds showing how to set enter messages for worlds, with special messages for world1 and lowgrass. Note the lowercase key 'lowgrass'.

```yaml
world: 
 enter:
   default: §aYou teleported to world '%0%'!
   world1: §aYou teleported to world 1, have a nice stay!
   lowgrass: §aYou teleported to the nicely built Lowgrass, have fun there!

```

--------------------------------

### Skip sign with station filter

Source: https://wiki.traincarts.net/p/Special%3AMyLanguage/TrainCarts/Signs/Skip

Example of a skip sign with a filter on the second line. The filter 'station' makes the skip mechanism only ignore signs whose second line starts with 'station', skipping the very next station sign while ignoring non-station signs. The filter is case-insensitive.

```plaintext
[+train]
skip station 0 1
```

--------------------------------

### Create and configure a scoreboard team

Source: https://wiki.traincarts.net/p/BKCommonLib/Scoreboards

Creates or retrieves a team named 'example', sets it visible to all, shows it, sets display name, prefix, and suffix, then adds a player. Note the typo 'nul' in the source.

```java
CommonTeam team = CommonScoreboard.getTeam("example");
if(team == nul) {
    team = CommonScoreboard.createTeam("example");
    team.setSendToAll(true); //set if team is visible for everyone
    team.show(); //Create team
    team.setDisplayName("Example"); //Not sure where this is used for
    team.setPrefix(ChatColor.RED.toString()); //Prefix (in front of name)
    team.setSuffix(" - Example");
}

team.addPlayer(player);
```

--------------------------------

### Portal sign example

Source: https://wiki.traincarts.net/p/MyWorlds/Portals

Example portal sign that teleports players to a portal named 'Portal1' in world 'HubWorld'.

```text
[portal]
Portal1
HubWorld

```

--------------------------------

### Show create usage with /world create

Source: https://wiki.traincarts.net/p/MyWorlds/ManagingWorlds/en

Lists the usage of /world create in combination with all available environments.

```text
/world create
```

--------------------------------

### Create and load or save a new FileConfiguration

Source: https://wiki.traincarts.net/p/BKCommonLib/ConfigurationAPI

Initializes a FileConfiguration for 'config.yml', loads it if it exists, otherwise sets default values and saves. Demonstrates the basic load/save pattern and getting values with explicit class types.

```java
FileConfiguration config = new FileConfiguration(this, "config.yml");
if (config.exists()) {
    config.load(); // Load the configuration from the file
} else {
    config.set("config1", 12);
    config.set("config2", 14);
    config.save(); // Saves the new data to file
}

System.out.println(config.get("config1", Integer.class));
System.out.println(config.get("config2", Integer.class));
```

--------------------------------

### Switcher sign examples

Source: https://wiki.traincarts.net/p/TC-Coasters/zh

Switcher sign syntax for TrainCarts. The first example switches junction 1 to direction 2 for empty trains and to direction 3 otherwise. The second example uses counter syntax to alternate trains between directions 2 and 3.

```plaintext
[+train]
switcher
1-2:empty
1-3:default
```

```plaintext
[+train]
switcher
1-2:1
1-3:1
```

--------------------------------

### Example YAML output with headers

Source: https://wiki.traincarts.net/p/BKCommonLib/ConfigurationAPI

Shows the YAML output produced by the Configuration API when headers are set. The main header uses a different syntax to avoid conflict with the first node header.

```yaml
# This is the configuration of MyAwesomePlugin

# Sets the awesomeness of this plugin
awesomeness: 85

# Controls what levels of awesomeness are enabled
enabledLevels:
  # Whether awesome looks are enabled
  looks: true
  # Whether awesome usage is enabled
  usage: false
```

--------------------------------

### Ejector sign absolute coordinates example

Source: https://wiki.traincarts.net/p/TrainCarts/Signs/Ejector/en

Example of the third line when using 'eject at': exact world coordinates to teleport players to.

```plaintext
154/67/-2442
```

--------------------------------

### Ejector sign offset example

Source: https://wiki.traincarts.net/p/TrainCarts/Signs/Ejector/en

Example of the third line offset when using 'eject': 0/0/4 ejects players to the left of the train.

```plaintext
0/0/4
```

--------------------------------

### World Creation Command Syntax

Source: https://wiki.traincarts.net/p/MyWorlds/Commands

Basic syntax for creating worlds with MyWorlds, including optional generator, arguments, and seed. Use /world, /myworlds, or /mw aliases.

```text
/world create [worldname]:[generator]:[arguments] [seed]
```

```text
/world create [worldname] [seed]
```

```text
/world create [worldname]/[environment] [seed]
```

--------------------------------

### Remote control ejector sign example

Source: https://wiki.traincarts.net/p/TrainCarts/Signs/Ejector/en

Example of remotely ejecting a train named 'train01' using [train train01] on the first line.

```plaintext
[train train01]
eject
0/2/0
```

--------------------------------

### SignActionWelcome.java - Custom Sign Action Example

Source: https://wiki.traincarts.net/p/Special%3AMyLanguage/TrainCarts/API/SignAction

Full example of a custom SignAction that sends a welcome message to all players in the train. It matches signs with 'welcome' on the second line, handles both train and cart signs, and uses SignBuildOptions for build handling.

```java
import org.bukkit.entity.Player;

import com.bergerkiller.bukkit.tc.controller.MinecartMember;
import com.bergerkiller.bukkit.tc.events.SignActionEvent;
import com.bergerkiller.bukkit.tc.events.SignChangeActionEvent;
import com.bergerkiller.bukkit.tc.signactions.SignAction;
import com.bergerkiller.bukkit.tc.signactions.SignActionType;
import com.bergerkiller.bukkit.tc.utils.SignBuildOptions;

/**
 * Displays a welcome message to the players in the train
 */
public class SignActionWelcome extends SignAction {

    @Override
    public boolean match(SignActionEvent info) {
        // Checks that the second line starts with 'welcome' (case-insensitive)
        return info.isType("welcome");
    }

    @Override
    public void execute(SignActionEvent info) {
        // When a [train] sign is placed, activate when powered by redstone when the train
        // goes over the sign, or when redstone is activated.
        if (info.isTrainSign()
                && info.isAction(SignActionType.GROUP_ENTER, SignActionType.REDSTONE_ON)
                && info.isPowered() && info.hasGroup()
        ) {
            for (MinecartMember<?> member : info.getGroup()) {
                sendGreetingForCart(info, member);
            }
            return;
        }

        // When a [cart] sign is placed, activate when powered by redstone when each cart
        // goes over the sign, or when redstone is activated.
        if (info.isCartSign()
                && info.isAction(SignActionType.MEMBER_ENTER, SignActionType.REDSTONE_ON)
                && info.isPowered() && info.hasMember()
        ) {
            sendGreetingForCart(info, info.getMember());
            return;
        }
    }

    public void sendGreetingForCart(SignActionEvent info, MinecartMember<?> member) {
        // Lines 3 and 4 configure the message to send
        String message = info.getLine(2) + info.getLine(3);

        // Send to all player passengers of the cart (could be multiple seats!)
        for (Player passenger : member.getEntity().getPlayerPassengers()) {
            passenger.sendMessage(message);
        }
    }

    @Override
    public boolean build(SignChangeActionEvent event) {
        // This is executed when a player places down a sign matching this sign action
        // Permissions are checked and then a message is displayed to the player
        // For simplicity you can use the SignBuildOptions API for this.
        // You are free to use your own code here that checks permissions/etc.
        return SignBuildOptions.create()
                .setName(event.isCartSign() ? "cart welcome greeter" : "train welcome greeter")
                .setDescription("sends a welcome message to all players in the train")
                .handle(event.getPlayer());
    }
}

```

--------------------------------

### Variable permission node example in PermissionDefaults.yml

Source: https://wiki.traincarts.net/p/Special%3AMyLanguage/BKCommonLib/PermissionDefaults

Example of a variable permission node structure in PermissionDefaults.yml. The '*' node sets the default for all sub-permissions, while specific sub-nodes (hammer, drill) can override it. In this example, OP players can use all tools, all players can use the hammer, and no one can use the drill by default.

```yaml
myplugin:
    use:
        '*':
            default: op
            description: Can use all tools
        hammer:
            default: true
            description: Can use the hammer tool
        drill:
            default: false
            description: Can use the drill tool

```
Tokens:
Raw